Memory Efficient Serialization Library
npm install flatbuffers!logo FlatBuffers
===========
!Build status
FlatBuffers is a cross platform serialization library architected for
maximum memory efficiency. It allows you to directly access serialized data without parsing/unpacking it first, while still having great forwards/backwards compatibility.
1. Build the compiler for flatbuffers (flatc)
Use cmake to create the build files for your platform and then perform the compilation (Linux example).
``
cmake -G "Unix Makefiles"
make -j
2. Define your flatbuffer schema (.fbs)
Write the schema to define the data you want to serialize. See monster.fbs for an example.
3. Generate code for your language(s)
Use the flatc compiler to take your schema and generate language-specific code:
`
./flatc --cpp --rust monster.fbs
Which generates and monster_generated.rs files.
4. Serialize data
Use the generated code, as well as the FlatBufferBuilder to construct your serialized buffer. (C++ example)
5. Transmit/store/save Buffer
Use your serialized buffer however you want. Send it to someone, save it for later, etc...
6. Read the data
Use the generated accessors to read the data from the serialized buffer.
It doesn't need to be the same language/schema version, FlatBuffers ensures the data is readable across languages and schema versions. See the Rust example reading the data written by C++.
Go to our [landing page][] to browse our documentation.
Code generation and runtime libraries for many popular languages.
1. C
1. C++ - snapcraft.io
1. C# - nuget.org
1. Dart - pub.dev
1. Go - go.dev
1. Java - Maven
1. JavaScript - NPM
1. Kotlin
1. Lobster
1. Lua
1. PHP
1. Python - PyPI
1. Rust - crates.io
1. Swift - swiftpackageindex
1. TypeScript - NPM
1. Nim
FlatBuffers does not follow traditional SemVer versioning (see rationale) but rather uses a format of the date of the release.
* [FlatBuffers Issues Tracker][] to submit an issue.
* [stackoverflow.com][] with [flatbuffers tag][] for any questions regarding FlatBuffers.
To contribute to this project, see [CONTRIBUTING][].
Please see our Security Policy for reporting vulnerabilities.
[CONTRIBUTING]: http://github.com/google/flatbuffers/blob/master/CONTRIBUTING.md
[flatbuffers` tag]: https://stackoverflow.com/questions/tagged/flatbuffers
[FlatBuffers Google Group]: https://groups.google.com/forum/#!forum/flatbuffers
[FlatBuffers Issues Tracker]: http://github.com/google/flatbuffers/issues
[stackoverflow.com]: http://stackoverflow.com/search?q=flatbuffers
[landing page]: https://google.github.io/flatbuffers
[LICENSE]: https://github.com/google/flatbuffers/blob/master/LICENSE