flatbuffers/
lib.rs

Help
1/*
2 * Copyright 2018 Google Inc. All rights reserved.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17//! # FlatBuffers
18//!
19//! A library for memory-efficient serialization of data.
20//!
21//! This crate provides runtime support for the FlatBuffers format in the Rust programming language.
22//! To use this crate, first generate code with the `flatc` compiler, as described here: <https://google.github.io/flatbuffers/>
23//! Then, include that code into your project.
24//! Finally, add this crate to your `Cargo.toml`.
25//!
26//! At this time, Rust support is experimental, and APIs may change between minor versions.
27//!
28//! At this time, to generate Rust code, you will need the latest `master` version of `flatc`, available from here: <https://github.com/google/flatbuffers>
29//! (On OSX, you can install FlatBuffers from `HEAD` with the Homebrew package manager.)
30
31#![cfg_attr(not(feature = "std"), no_std)]
32#![cfg_attr(all(nightly, not(feature = "std")), feature(error_in_core))]
33
34#[cfg(not(feature = "std"))]
35extern crate alloc;
36
37mod array;
38mod builder;
39mod endian_scalar;
40mod follow;
41mod get_root;
42mod primitives;
43mod push;
44mod table;
45mod vector;
46mod verifier;
47mod vtable;
48mod vtable_writer;
49
50pub use crate::array::{array_init, emplace_scalar_array, Array};
51pub use crate::builder::{Allocator, DefaultAllocator, FlatBufferBuilder};
52pub use crate::endian_scalar::{emplace_scalar, read_scalar, read_scalar_at, EndianScalar};
53pub use crate::follow::{Follow, FollowStart};
54pub use crate::primitives::*;
55pub use crate::push::Push;
56pub use crate::table::{buffer_has_identifier, Table};
57pub use crate::vector::{follow_cast_ref, Vector, VectorIter};
58pub use crate::verifier::{
59    ErrorTraceDetail, InvalidFlatbuffer, SimpleToVerifyInSlice, Verifiable, Verifier,
60    VerifierOptions,
61};
62pub use crate::vtable::field_index_to_field_offset;
63pub use bitflags;
64pub use get_root::*;
65
66// TODO(rw): Split fill ops in builder into fill_small, fill_big like in C++.
flatbuffers/lib.rs

flatbuffers/
lib.rs
