| commit | f4a9c5325b7cba8ae432466bdfb90f857da0d593 | [log] [tgz] |
|---|---|---|
| author | Fergus Henderson <fergus.henderson@gmail.com> | Tue Apr 02 20:50:15 2024 +0100 |
| committer | GitHub <noreply@github.com> | Tue Apr 02 12:50:15 2024 -0700 |
| tree | dfa7e18772c97215f9762a80fe4f917c50cba00d | |
| parent | 8f2e1dbd88d25ca76cbcaf9ac8c9919e0a787d31 [diff] |
Avoid ODR violations with flatbuffers::Verifier. (#8274) Fix "One Definition Rule" violation when using flatbuffers::Verifier with FLATBUFFERS_TRACK_VERIFIER_BUFFER_SIZE defined in some compilation units and not defined in other compilation units. The fix is to make Verifier a template class, with a boolean template parameter replacing the "#ifdef" conditionals; to rename it as VerifierTemplate; and then to use "#ifdef" only for a "using" declaration that defines the original name Verifier an an alias for the instantiated template. In this way, even if FLATBUFFERS_TRACK_VERIFIER_BUFFER_SIZE is defined in some compilation units and not in others, as long as clients only reference flatbuffers::Verifier in .cc files, not header files, there will be no ODR violation, since the only part whose definition varies is the "using" declaration, which does not have external linkage. There is still some possibility of clients creating ODR violations if the client header files (rather than .cc files) reference flatbuffers::Verifier. To avoid that, this change also deprecates FLATBUFFERS_TRACK_VERIFIER_BUFFER_SIZE, and instead introduces flatbuffers::SizeVerifier as a public name for the template instance with the boolean parameter set to true, so that clients don't need to define the macro at all.
FlatBuffers
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.
Build the compiler for flatbuffers (flatc)
Use cmake to create the build files for your platform and then perform the compliation (Linux example).
cmake -G "Unix Makefiles" make -j
Define your flatbuffer schema (.fbs)
Write the schema to define the data you want to serialize. See monster.fbs for an example.
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.
Serialize data
Use the generated code, as well as the FlatBufferBuilder to construct your serialized buffer. (C++ example)
Transmit/store/save Buffer
Use your serialized buffer however you want. Send it to someone, save it for later, etc...
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.
FlatBuffers does not follow traditional SemVer versioning (see rationale) but rather uses a format of the date of the release.
flatbuffers tag for any questions regarding FlatBuffers.To contribute to this project, see CONTRIBUTING.
Please see our Security Policy for reporting vulnerabilities.
Flatbuffers is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.