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 array; 32 mod builder; 33 mod endian_scalar; 34 mod follow; 35 mod get_root; 36 mod primitives; 37 mod push; 38 mod table; 39 mod vector; 40 mod verifier; 41 mod vtable; 42 mod vtable_writer; 43 44 pub use crate::array::{array_init, emplace_scalar_array, Array}; 45 pub use crate::builder::FlatBufferBuilder; 46 pub use crate::endian_scalar::{ 47 byte_swap_f32, byte_swap_f64, emplace_scalar, read_scalar, read_scalar_at, EndianScalar, 48 }; 49 pub use crate::follow::{Follow, FollowStart}; 50 pub use crate::primitives::*; 51 pub use crate::push::Push; 52 pub use crate::table::{buffer_has_identifier, Table}; 53 pub use crate::vector::{follow_cast_ref, SafeSliceAccess, Vector, VectorIter}; 54 pub use crate::verifier::{ 55 ErrorTraceDetail, InvalidFlatbuffer, SimpleToVerifyInSlice, Verifiable, Verifier, 56 VerifierOptions, 57 }; 58 pub use crate::vtable::field_index_to_field_offset; 59 pub use bitflags; 60 pub use get_root::*; 61 62 // TODO(rw): Unify `create_vector` and `create_vector_direct` by using 63 // `Into<Vector<...>>`. 64 // TODO(rw): Split fill ops in builder into fill_small, fill_big like in C++. 65