From 9e648c392be640fcfd464de21428c02cfdafbc79 Mon Sep 17 00:00:00 2001 From: Robert Date: Mon, 3 Sep 2018 18:01:31 -0700 Subject: [PATCH] Rust: Add basic crate-level documentation --- rust/flatbuffers/src/lib.rs | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/rust/flatbuffers/src/lib.rs b/rust/flatbuffers/src/lib.rs index 1783b34..5e30434 100644 --- a/rust/flatbuffers/src/lib.rs +++ b/rust/flatbuffers/src/lib.rs @@ -14,6 +14,20 @@ * limitations under the License. */ +//! # FlatBuffers +//! +//! A library for memory-efficient serialization of data. +//! +//! This crate provides runtime support for the FlatBuffers format in the Rust programming language. +//! To use this crate, first generate code with the `flatc` compiler, as described here: https://google.github.io/flatbuffers/ +//! Then, include that code into your project. +//! Finally, add this crate to your `Cargo.toml`. +//! +//! At this time, Rust support is experimental, and APIs may change between minor versions. +//! +//! At this time, to generate Rust code, you will need the latest `master` version of `flatc`, available from here: https://github.com/google/flatbuffers +//! (On OSX, you can install FlatBuffers from `HEAD` with the Homebrew package manager.) + mod builder; mod endian_scalar; mod follow; -- 2.7.4