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 mod builder;
32 mod endian_scalar;
33 mod follow;
34 mod primitives;
35 mod push;
36 mod table;
37 mod vector;
38 mod vtable;
39 mod vtable_writer;
40 
41 pub use builder::FlatBufferBuilder;
42 pub use endian_scalar::{
43     byte_swap_f32, byte_swap_f64, emplace_scalar, read_scalar, read_scalar_at, EndianScalar,
44 };
45 pub use follow::{Follow, FollowStart};
46 pub use primitives::*;
47 pub use push::Push;
48 pub use table::{buffer_has_identifier, get_root, get_size_prefixed_root, Table};
49 pub use vector::{follow_cast_ref, SafeSliceAccess, Vector, VectorIter};
50 pub use vtable::field_index_to_field_offset;
51 
52 // TODO(rw): Unify `create_vector` and `create_vector_direct` by using
53 //           `Into<Vector<...>>`.
54 // TODO(rw): Split fill ops in builder into fill_small, fill_big like in C++.
55