google /flatbuffers
FlatBuffers: Memory Efficient Serialization Library
★ 26,636⑂ 3,732👁 617⑃ 3,314● 2,681▤ 45
+4
Daily
+27
Weekly
+75
Monthly
26,636
stars
3,732
forks
617
watchers
3,314
prs
2,681
issues
45
releases
README
!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.
Quick Start
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 monster_generated.h 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++.
Documentation
Go to our [landing page][] to browse our documentation.
Supported operating systems
- Windows
- macOS
- Linux
- Android
- And any others with a recent C++ compiler (C++ 11 and newer)
Supported programming languages
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
Versioning
FlatBuffers does not follow traditional SemVer versioning (see rationale) but rather uses a format of the date of the release.
Contribution
[FlatBuffers Issues Tracker][] to submit an issue.
[stackoverflow.com][] with [flatbuffers tag][] for any questions regarding FlatBuffers.
To contribute to this project, see [CONTRIBUTING][].
Community
Discord Server
Security
Please see our Security Policy for reporting vulnerabilities.
Licensing
Flatbuffers is licensed under the Apache License, Version 2.0. See [LICENSE][] for the full license text.
[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.iTop issues
#5875What would a "FlatBuffers2" binary format look like?135 comments · 2020-04-26#7111Make property renaming optional84 comments · 2022-02-20#6053Feature: Increased support for defaults in tables42 comments · 2020-07-29#5024Rust: Implement Vectors of Unions35 comments · 2018-11-01#6627Rust: various unsafe traits/functions meant for gencode in public API29 comments · 2021-05-10#4919Tracking issue: Rust gRPC28 comments · 2018-09-05#6741[TS] In version 2, why do union helpers use string comparison?22 comments · 2021-07-19#4969native_type for tables in c++ object based api22 comments · 2018-10-04
Discussions
#9466Using a recent version of FlatBuffers with the VS2010 C++ toolchain1 comments · 2026-11-06#9114New Haskell implementation?0 comments · 2026-06-01#8984Thank you to all the new contributors - a short note on reviews2 comments · 2026-03-19#8956Rust Macro for FlatBuffers That Defines another Macro0 comments · 2026-03-06#8942Best practice for portable `flatc` execution in Maven?1 comments · 2026-02-26#8837[Java][New Feature] Add Java builder for table object0 comments · 2025-12-09#8739Rust Macro for slightly simplifying flatbuffers0 comments · 2025-10-27#8697Are different flatbuffers versions compatible?0 comments · 2025-09-12