Struct MapBuilder

pub struct MapBuilder<'a> { /* private fields */ }

Builds a Flexbuffer map, returned by a Builder.

Side effect when dropped:

When this is dropped, or end_map is called, the map is commited to the buffer. If this map is the root of the flexbuffer, then the root is written and the flexbuffer is complete.

Panics:

• Duplicate keys will result in a panic in both debug and release mode.
• Keys with internal nulls results in a panic in debug mode and result in silent truncaction in release mode.

Implementations

impl<'a> MapBuilder<'a>

pub fn push<P: Pushable>(&mut self, key: &str, p: P)

Push p onto this map with key key. This will panic (in debug mode) if key contains internal nulls.

pub fn start_vector(&mut self, key: &str) -> VectorBuilder<'_>

Starts a nested vector that will be pushed onto this map with key key when it is dropped.

This will panic (in debug mode) if key contains internal nulls.

pub fn start_map(&mut self, key: &str) -> MapBuilder<'_>

Starts a nested map which that will be pushed onto this map with key key when it is dropped.

This will panic (in debug mode) if key contains internal nulls.

pub fn end_map(self)

end_map sorts the map by key and writes it to the buffer. This happens anyway when the map builder is dropped.

Trait Implementations

impl<'a> Drop for MapBuilder<'a>

fn drop(&mut self)

Executes the destructor for this type.