xref: /aosp_15_r20/external/flatbuffers/swift/Sources/FlatBuffers/Documentation.docc/Documentation.md (revision 890232f25432b36107d06881e0a25aaa6b473652)
1*890232f2SAndroid Build Coastguard Worker# ``FlatBuffers``
2*890232f2SAndroid Build Coastguard Worker
3*890232f2SAndroid Build Coastguard WorkerFlatBuffers: Memory Efficient Serialization Library
4*890232f2SAndroid Build Coastguard Worker
5*890232f2SAndroid Build Coastguard Worker## Overview
6*890232f2SAndroid Build Coastguard Worker
7*890232f2SAndroid Build Coastguard Worker- Access to serialized data without parsing/unpacking - What sets FlatBuffers apart is that it represents hierarchical data in a flat binary buffer in such a way that it can still be accessed directly without parsing/unpacking, while also still supporting data structure evolution (forwards/backwards compatibility).
8*890232f2SAndroid Build Coastguard Worker- Memory efficiency and speed - The only memory needed to access your data is that of the buffer. It requires 0 additional allocations (in C++, other languages may vary). FlatBuffers is also very suitable for use with mmap (or streaming), requiring only part of the buffer to be in memory. Access is close to the speed of raw struct access with only one extra indirection (a kind of vtable) to allow for format evolution and optional fields. It is aimed at projects where spending time and space (many memory allocations) to be able to access or construct serialized data is undesirable, such as in games or any other performance sensitive applications. See the benchmarks for details.
9*890232f2SAndroid Build Coastguard Worker- Flexible - Optional fields means not only do you get great forwards and backwards compatibility (increasingly important for long-lived games: don't have to update all data with each new version!). It also means you have a lot of choice in what data you write and what data you don't, and how you design data structures.
10*890232f2SAndroid Build Coastguard Worker- Tiny code footprint - Small amounts of generated code, and just a single small header as the minimum dependency, which is very easy to integrate. Again, see the benchmark section for details.
11*890232f2SAndroid Build Coastguard Worker- Strongly typed - Errors happen at compile time rather than manually having to write repetitive and error prone run-time checks. Useful code can be generated for you.
12*890232f2SAndroid Build Coastguard Worker
13*890232f2SAndroid Build Coastguard Worker## Topics
14*890232f2SAndroid Build Coastguard Worker
15*890232f2SAndroid Build Coastguard Worker### Read this first
16*890232f2SAndroid Build Coastguard Worker
17*890232f2SAndroid Build Coastguard Worker- <doc:Tutorial_Table_of_Contents>
18*890232f2SAndroid Build Coastguard Worker
19*890232f2SAndroid Build Coastguard Worker### Where to start
20*890232f2SAndroid Build Coastguard Worker
21*890232f2SAndroid Build Coastguard Worker- ``FlatBufferBuilder``
22*890232f2SAndroid Build Coastguard Worker- ``ByteBuffer``
23