| FlatBuffers An open source project by FPL.

Use in Rust

# Before you get started

Before diving into the FlatBuffers usage in Rust, it should be noted that the Tutorial page has a complete guide to general FlatBuffers usage in all of the supported languages (including Rust). This page is designed to cover the nuances of FlatBuffers usage, specific to Rust.

### Prerequisites

This page assumes you have written a FlatBuffers schema and compiled it with the Schema Compiler. If you have not, please see Using the schema compiler and Writing a schema.

Assuming you wrote a schema, say `mygame.fbs` (though the extension doesn't matter), you've generated a Rust file called `mygame_generated.rs` using the compiler (e.g. `flatc --rust mygame.fbs` or via helpers listed in "Useful tools created by others" section bellow), you can now start using this in your program by including the file. As noted, this header relies on the crate `flatbuffers`, which should be in your include `Cargo.toml`.

# FlatBuffers Rust library code location

The code for the FlatBuffers Rust library can be found at `flatbuffers/rust`. You can browse the library code on the FlatBuffers GitHub page.

# Testing the FlatBuffers Rust library

The code to test the Rust library can be found at `flatbuffers/tests/rust_usage_test`. The test code itself is located in integration_test.rs

This test file requires `flatc` to be present. To review how to build the project, please read the Building documenation.

To run the tests, execute `RustTest.sh` from the `flatbuffers/tests` directory. For example, on Linux, you would simply run: `cd tests && ./RustTest.sh`.

Note: The shell script requires Rust to be installed.

# Using the FlatBuffers Rust library

Note: See Tutorial for a more in-depth example of how to use FlatBuffers in Rust.

FlatBuffers supports both reading and writing FlatBuffers in Rust.

To use FlatBuffers in your code, first generate the Rust modules from your schema with the `--rust` option to `flatc`. Then you can import both FlatBuffers and the generated code to read or write FlatBuffers.

For example, here is how you would read a FlatBuffer binary file in Rust: First, include the library and generated code. Then read the file into a `u8` vector, which you pass, as a byte slice, to `get_root_as_monster()`.

This full example program is available in the Rust test suite: monster_example.rs

It can be run by `cd`ing to the `rust_usage_test` directory and executing: `cargo run monster_example`.

extern crate flatbuffers;
#[allow(dead_code, unused_imports)]
#[path = "../../monster_test_generated.rs"]
mod monster_test_generated;
pub use monster_test_generated::my_game;
use std::io::Read;
fn main() {
let mut f = std::fs::File::open("../monsterdata_test.mon").unwrap();
let mut buf = Vec::new();
f.read_to_end(&mut buf).expect("file reading failed");
let monster = my_game::example::get_root_as_monster(&buf[..]);

`monster` is of type `Monster`, and points to somewhere inside your buffer (root object pointers are not the same as `buffer_pointer` !). If you look in your generated header, you'll see it has convenient accessors for all fields, e.g. `hp()`, `mana()`, etc:

println!("{}", monster.hp()); // `80`
println!("{}", monster.mana()); // default value of `150`
println!("{:?}", monster.name()); // Some("MyMonster")
}

Note: That we never stored a `mana` value, so it will return the default.

# Direct memory access

As you can see from the above examples, all elements in a buffer are accessed through generated accessors. This is because everything is stored in little endian format on all platforms (the accessor performs a swap operation on big endian machines), and also because the layout of things is generally not known to the user.

For structs, layout is deterministic and guaranteed to be the same across platforms (scalars are aligned to their own size, and structs themselves to their largest member), and you are allowed to access this memory directly by using `safe_slice` and on the reference to a struct, or even an array of structs.

To compute offsets to sub-elements of a struct, make sure they are structs themselves, as then you can use the pointers to figure out the offset without having to hardcode it. This is handy for use of arrays of structs with calls like `glVertexAttribPointer` in OpenGL or similar APIs.

It is important to note is that structs are still little endian on all machines, so only use tricks like this if you can guarantee you're not shipping on a big endian machine (using an `#[cfg(target_endian = "little")]` attribute would be wise).

The special function `safe_slice` is implemented on Vector objects that are represented in memory the same way as they are represented on the wire. This function is always available on vectors of struct, bool, u8, and i8. It is conditionally-compiled on little-endian systems for all the remaining scalar types.

The FlatBufferBuilder function `create_vector_direct` is implemented for all types that are endian-safe to write with a `memcpy`. It is the write-equivalent of `safe_slice`.

# Access of untrusted buffers

The generated accessor functions access fields over offsets, which is very quick. These offsets are used to index into Rust slices, so they are bounds-checked by the Rust runtime. However, our Rust implementation may change: we may convert access functions to use direct pointer dereferencing, to improve lookup speed. As a result, users should not rely on the aforementioned bounds-checking behavior.

When you're processing large amounts of data from a source you know (e.g. your own generated data on disk), this is acceptable, but when reading data from the network that can potentially have been modified by an attacker, this is undesirable.

The C++ port provides a buffer verifier. At this time, Rust does not. Rust may provide a verifier in a future version. In the meantime, Rust users can access the buffer verifier generated by the C++ port through a foreign function interface (FFI).

# Threading

Reading a FlatBuffer does not touch any memory outside the original buffer, and is entirely read-only (all immutable), so is safe to access from multiple threads even without synchronisation primitives.

Creating a FlatBuffer is not thread safe. All state related to building a FlatBuffer is contained in a FlatBufferBuilder instance, and no memory outside of it is touched. To make this thread safe, either do not share instances of FlatBufferBuilder between threads (recommended), or manually wrap it in synchronisation primitives. There's no automatic way to accomplish this, by design, as we feel multithreaded construction of a single buffer will be rare, and synchronisation overhead would be costly.

# Useful tools created by others

- flatc-rust - FlatBuffers compiler (flatc) as API for transparent `.fbs` to `.rs` code-generation via Cargo build scripts integration.