flatbuffers/dart
Ian Hickson 0a80646371
Fix references to LICENSE file (#7377)
* Fix references to LICENSE file

This was broken by https://github.com/google/flatbuffers/pull/7073

* Update flat_buffers_test.dart
2022-07-07 16:06:19 -07:00
..
example dart - add Packable interface (#6846) 2021-09-28 13:23:30 -07:00
lib Fix references to LICENSE file (#7377) 2022-07-07 16:06:19 -07:00
test Fix references to LICENSE file (#7377) 2022-07-07 16:06:19 -07:00
CHANGELOG.md chore: dart 2.0.5 release changes (#6983) 2022-01-20 13:30:03 -08:00
LICENSE removed BSD-3-Clause license and Zlib licenses (#7073) 2022-02-02 13:12:01 -08:00
README.md chore: dart 2.0.5 release changes (#6983) 2022-01-20 13:30:03 -08:00
analysis_options.yaml Dart lints (#6808) 2021-08-30 12:54:59 -07:00
publish.sh Dart 2.0 release prep (#6759) 2021-08-02 13:31:36 -07:00
pubspec.yaml chore: dart 2.0.5 release changes (#6983) 2022-01-20 13:30:03 -08:00

README.md

FlatBuffers for Dart

This package is used to read and write FlatBuffers.

Most consumers will want to use the flatc - FlatBuffer compiler binary for your platform. You can find it in the generator/{Platform} directory of the released package archive.

The FlatBuffer compiler flatc reads a FlatBuffers IDL schema and generates Dart code. The generated classes can be used to read or write binary data/files that are interoperable with other languages and platforms supported by FlatBuffers, as illustrated in the example.dart in the examples folder.

For more details and documentation, head over to the official site and read the Tutorial and how to use FlatBuffers in Dart.

Dart 2.0 notes

Version 2.0.5 ships with it's own custom build of flatc because this is an extraordinary release to catch-up with FlatBuffers for other platforms. This generator can only generate dart code (to avoid generating code for other platforms which isn't released yet). On the other hand, the generated code still produces standard binary FlatBuffers compatible with other languages. In other words: only flatc --dart ... works with this generator, but your app will be able to produce and read standard binary (Uint8List) FlatBuffers that are fully compotible with other languages supporting FlatBuffers (e.g. Java, C++, ...).

In the future a common flatc binary for all platforms would be shipped through GitHub release page instead.