flatbuffers README

The project's README from github.com/google/flatbuffers. As one markdown file: README.md.

logo FlatBuffers

Build status BuildKite status Fuzzing Status Discord Chat Twitter Follow Twitter Follow

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

Supported programming languages

Code generation and runtime libraries for many popular languages.

  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.

Contribution

To contribute to this project, see CONTRIBUTING.

Community

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.


flatbuffers (google/flatbuffers)

Searching Database…

Что это такое?FlatBuffers — это кроссплатформенная библиотека сериализации, созданная для максимальной экономии памяти: сериализованные данные можно читать напрямую, без этапа разбора и распаковки, а совместимость с новыми и старыми версиями сохраняется.
Это библиотека, которую я подключаю к своему коду, или отдельная утилита?И то и другое: есть библиотеки времени выполнения, которые вы подключаете к своему приложению, плюс компилятор flatc, который берёт вашу схему из файла .fbs и генерирует код для доступа к данным и их сборки под конкретный язык.
Какие шаги нужны, чтобы записать мои данные в FlatBuffer?Соберите flatc с помощью cmake, опишите схему в файле .fbs, запустите flatc, чтобы сгенерировать код для вашего языка, сериализуйте данные с помощью FlatBufferBuilder, а затем читайте буфер через сгенерированные методы доступа.
Из каких языков можно этим пользоваться?Генерация кода и библиотеки есть для C, C++, C#, Dart, Go, Java, JavaScript, Kotlin, Lobster, Lua, PHP, Python, Rust, Swift, TypeScript и Nim; распространяется через npm, PyPI, NuGet, Maven, crates.io, pub.dev и не только.
Есть ли подводные камни с версиями, когда я подключаю её как зависимость?Да — релизы датируются, а не следуют SemVer, так что при фиксации версии в вашем пакетном менеджере не ждите номеров вида 1.2.3.
Работает ли это на Windows и macOS или только на Linux?Везде — Windows, macOS, Linux и Android официально поддерживаются, плюс любая другая ОС со свежим компилятором C++ (C++ 11 или новее).
Это бесплатно, в том числе для коммерческого использования?Да, проект распространяется по лицензии Apache License 2.0 — это разрешительная лицензия с открытым исходным кодом, платных тарифов нет.
Могу ли я прочитать буфер, записанный на другом языке или по старой версии схемы?Да. Для чтения не нужны тот же язык или та же версия схемы — FlatBuffers сохраняет читаемость данных между языками и версиями схем; в README показан пример, где Rust читает буфер, созданный на C++.
Почему выбрать её, а не формат, который нужно разбирать, например JSON?Главный аргумент: вы обращаетесь к сериализованным данным напрямую, без предварительного разбора и распаковки — отсюда и экономия памяти, а совместимость между версиями встроена изначально.
Creator
google
Size
21.7 MB
Stars
26.6K
Age
12y
Commits · 90 Days