Crate flexbuffers

Flexbuffers is a high performance schemaless binary data format designed at Google. It is complementary to the schema-ed format Flatbuffers. See Flexbuffer Internals for details on the binary format.

See the examples for usage:

• Example
• Serde Example

This rust implementation is in progress and, until the 1.0 release, breaking API changes may happen between minor versions.

Structs

Blob

This struct, when pushed will be serialized as a FlexBufferType::Blob.

Builder

Use this struct to build a Flexbuffer.

BuilderOptions

Options for sharing data within a flexbuffer.

FlexbufferSerializer

Flexbuffer Serializer. This should be used to serialize structs.

IndirectFloat

This struct, when pushed, will be serialized as a FlexBufferType::IndirectFloat.

IndirectInt

This struct, when pushed, will be serialized as a FlexBufferType::IndirectInt.

IndirectUInt

This struct, when pushed, will be serialized as a FlexBufferType::IndirectUInt.

MapBuilder

Builds a Flexbuffer map, returned by a Builder.

MapReader

Allows indexing on a flexbuffer map.

Reader

Readers allow access to data stored in a Flexbuffer.

ReaderIterator

Iterates over a flexbuffer vector, typed vector, or map. Yields Readers.

VectorBuilder

Builds a Flexbuffer vector, returned by a Builder.

VectorReader

Allows indexing on any flexbuffer vector type, (heterogenous vector, typed vector, or fixed length typed vector).

Enums

BitWidth

Represents the size of Flexbuffers data.

DeserializationError

Errors that may happen when deserializing a flexbuffer with serde.

FlexBufferType

Represents all the valid types in a flexbuffer.

ReaderError

All the possible errors when reading a flexbuffer.

SerializationError

Errors that may happen with Serde.

Traits

Buffer

The underlying buffer that is used by a flexbuffer Reader.

Pushable

Types that implement the Pushable trait can be written into a Flexbuffer.

Functions

from_buffer

Deserialize a type from a flexbuffer.

from_slice

Deserialize a type from a flexbuffer.

singleton

Builds a Flexbuffer with the single pushed value as the root.

to_vec

Serialize as a flexbuffer into a vector.