google/flatbuffers

FlatBuffers for PHP

FlatBuffers

, _(*1)

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., _(*2)

Quick Start

1. Build the compiler for flatbuffers (flatc), _(*3)

   Use cmake to create the build files for your platform and then perform the compilation (Linux example)., _(*4)

   cmake -G "Unix Makefiles"
   make -j
   

2. Define your flatbuffer schema (.fbs), _(*5)

   Write the schema to define the data you want to serialize. See monster.fbs for an example., _(*6)

3. Generate code for your language(s), _(*7)

   Use the flatc compiler to take your schema and generate language-specific code:, _(*8)

   ./flatc --cpp --rust monster.fbs
   

   Which generates monster_generated.h and monster_generated.rs files., _(*9)

4. Serialize data, _(*10)

   Use the generated code, as well as the FlatBufferBuilder to construct your serialized buffer. (C++ example), _(*11)

5. Transmit/store/save Buffer, _(*12)

   Use your serialized buffer however you want. Send it to someone, save it for later, etc..., _(*13)

6. Read the data, _(*14)

   Use the generated accessors to read the data from the serialized buffer., _(*15)

   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++., _(*16)

Documentation

Go to our landing page to browse our documentation., _(*17)

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., _(*18)

1. C
2. C++ - snapcraft.io
3. C# - nuget.org
4. Dart - pub.dev
5. Go - go.dev
6. Java - Maven
7. JavaScript - NPM
8. Kotlin
9. Lobster
10. Lua
11. PHP
12. Python - PyPI
13. Rust - crates.io
14. Swift - swiftpackageindex
15. TypeScript - NPM
16. Nim

Versioning

FlatBuffers does not follow traditional SemVer versioning (see rationale) but rather uses a format of the date of the release., _(*19)

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., _(*20)

Community

• Discord Server

Security

Please see our Security Policy for reporting vulnerabilities., _(*21)

Licensing

Flatbuffers is licensed under the Apache License, Version 2.0. See LICENSE for the full license text., _(*22)

, _(*23)