BigfootDev/flatbuffers
1
0
Fork 1
mirror of https://github.com/google/flatbuffers.git synced 2026-06-05 21:17:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rust Flexbuffers Documentation update (#5979)

Browse Source 
* Update samples and docs

* Fixed a line of documentation

Co-authored-by: Casper Neo <cneo@google.com>
This commit is contained in:
Casper
2020-06-18 00:01:48 -07:00
committed by GitHub
parent 24ad35709d
commit 12ddc8a920
4 changed files with 37 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
rust/flexbuffers/README.md
View File

@@ -10,5 +10,13 @@ FlexBuffers' design and implementation allows for a very compact encoding,
with automatic sizing of containers to their smallest possible representation
(8/16/32/64 bits). Many values and offsets can be encoded in just 8 bits.
FlexBuffers supports [Serde](https://serde.rs/) for automatically serializing
Rust data structures into its binary format.
## See Examples for Usage:
* [Example](https://github.com/google/flatbuffers/blob/master/samples/sample_flexbuffers.rs)
* [Serde Example](https://github.com/google/flatbuffers/blob/master/samples/sample_flexbuffers_serde.rs)
* [Documentation](https://docs.rs/flexbuffers)
Flexbuffers is the schema-less cousin of
[Flatbuffers](https://google.github.io/flatbuffers/).

6
rust/flexbuffers/src/lib.rs
View File

@@ -18,10 +18,12 @@
//! See [Flexbuffer Internals](https://google.github.io/flatbuffers/flatbuffers_internals.html)
//! for details on the binary format.
//!
//! * [See the examples for usage.](https://github.com/CasperN/flexbuffers/tree/master/examples)
//! See the examples for usage:
//! * [Example](https://github.com/google/flatbuffers/blob/master/samples/sample_flexbuffers.rs)
//! * [Serde Example](https://github.com/google/flatbuffers/blob/master/samples/sample_flexbuffers_serde.rs)
//!
//! This rust implementation is in progress and, until the 1.0 release, breaking API changes may
/// happen between minor versions.
//! happen between minor versions.
// TODO(cneo): serde stuff are behind a default-on feature flag
// Reader to Json is behind a default-off feature flag
// Serializable structs are Pushable