Struct Reader

pub struct Reader<B> { /* private fields */ }

Readers allow access to data stored in a Flexbuffer.

Each reader represents a single address in the buffer so data is read lazily. Start a reader by calling get_root on your flexbuffer &[u8].

• The get_T methods return a Result<T, Error>. They return an OK value if and only if the flexbuffer type matches T. This is analogous to the behavior of Rust’s json library, though with Result instead of Option.
• The as_T methods will try their best to return to a value of type T (by casting or even parsing a string if necessary) but ultimately returns T::default if it fails. This behavior is analogous to that of flexbuffers C++.

Implementations

impl<B: Buffer> Reader<B>

pub fn get_root(buffer: B) -> Result<Self, Error>

Parses the flexbuffer from the given buffer. Assumes the flexbuffer root is the last byte of the buffer.

pub fn buffer(&self) -> B

Convenience function to get the underlying buffer. By using shallow_copy, this preserves the lifetime that the underlying buffer has.

pub fn flexbuffer_type(&self) -> FlexBufferType

Returns the FlexBufferType of this Reader.

pub fn bitwidth(&self) -> BitWidth

Returns the bitwidth of this Reader.

pub fn length(&self) -> usize

Returns the length of the Flexbuffer. If the type has no length, or if an error occurs, 0 is returned.

pub fn is_aligned(&self) -> bool

Returns true if the flexbuffer is aligned to 8 bytes. This guarantees, for valid flexbuffers, that the data is correctly aligned in memory and slices can be read directly e.g. with get_f64s or get_i16s.

pub fn as_vector(&self) -> VectorReader<B>

pub fn as_map(&self) -> MapReader<B>

pub fn get_slice<T: ReadLE>(&self) -> Result<&[T], Error>

👎Deprecated since 0.3.0: This function is unsafe - if this functionality is needed use Reader::buffer::align_to

Directly reads a slice of type T where T is one of u8,u16,u32,u64,i8,i16,i32,i64,f32,f64. Returns Err if the type, bitwidth, or memory alignment does not match. Since the bitwidth is dynamic, its better to use a VectorReader unless you know your data and performance is critical.

pub fn get_bool(&self) -> Result<bool, Error>

Returns the value of the reader if it is a boolean. Otherwise Returns error.

pub fn get_key(&self) -> Result<B::BufferString, Error>

Retrieves the string value up until the first \0 character.

pub fn get_blob(&self) -> Result<Blob<B>, Error>

pub fn as_blob(&self) -> Blob<B>

pub fn get_str(&self) -> Result<B::BufferString, Error>

Retrieves str pointer, errors if invalid UTF-8, or the provided index is out of bounds.

pub fn get_map(&self) -> Result<MapReader<B>, Error>

pub fn get_u64(&self) -> Result<u64, Error>

Tries to read a FlexBufferType::UInt. Returns Err if the type is not a UInt or if the address is out of bounds.

pub fn get_i64(&self) -> Result<i64, Error>

Tries to read a FlexBufferType::Int. Returns Err if the type is not a UInt or if the address is out of bounds.

pub fn get_f64(&self) -> Result<f64, Error>

Tries to read a FlexBufferType::Float. Returns Err if the type is not a UInt, if the address is out of bounds, or if its a f16 or f8 (not currently supported).

pub fn as_bool(&self) -> bool

pub fn as_u64(&self) -> u64

Returns a u64, casting if necessary. For Maps and Vectors, their length is returned. If anything fails, 0 is returned.

pub fn as_u32(&self) -> u32

pub fn as_u16(&self) -> u16

pub fn as_u8(&self) -> u8

pub fn as_i64(&self) -> i64

Returns an i64, casting if necessary. For Maps and Vectors, their length is returned. If anything fails, 0 is returned.

pub fn as_i32(&self) -> i32

pub fn as_i16(&self) -> i16

pub fn as_i8(&self) -> i8

pub fn as_f64(&self) -> f64

Returns an f64, casting if necessary. For Maps and Vectors, their length is returned. If anything fails, 0 is returned.

pub fn as_f32(&self) -> f32

pub fn as_str(&self) -> B::BufferString

Returns empty string if you’re not trying to read a string.

pub fn get_vector(&self) -> Result<VectorReader<B>, Error>

Trait Implementations

impl<B: Buffer> Clone for Reader<B>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<B> Debug for Reader<B>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<B: Buffer> Default for Reader<B>

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserializer<'de> for Reader<&'de [u8]>

type Error = DeserializationError

The error type that can be returned if some error occurs during deserialization.

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form.

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input.

fn deserialize_bool<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a bool value.

fn deserialize_i8<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_u8<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_f32<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_str<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_unit<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit value.

fn deserialize_unit_struct<V>( self, name: &'static str, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit struct with a particular name.

fn deserialize_bytes<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_ignored_any<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored.

fn deserialize_map<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a map of key-value pairs.

fn deserialize_identifier<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant.

fn deserialize_struct<V>( self, name: &'static str, fields: &'static [&'static str], visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a struct with a particular name and fields.

fn deserialize_tuple<V>( self, len: usize, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data.

fn deserialize_tuple_struct<V>( self, name: &'static str, len: usize, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.

fn deserialize_seq<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values.

fn deserialize_string<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_char<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a char value.

fn deserialize_byte_buf<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an optional value.

fn deserialize_newtype_struct<V>( self, _name: &'static str, visitor: V, ) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a newtype struct with a particular name.

fn deserialize_enum<V>( self, _name: &'static str, _variants: &'static [&'static str], visitor: V, ) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

fn deserialize_i128<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u128<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an u128 value.

impl<B: Buffer> Display for Reader<B>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<B: Buffer> Serialize for &Reader<B>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'de> VariantAccess<'de> for Reader<&'de [u8]>

type Error = DeserializationError

The error type that can be returned if some error occurs during deserialization. Must match the error type of our EnumAccess.

fn unit_variant(self) -> Result<(), Self::Error>

Called when deserializing a variant with no values.

fn newtype_variant_seed<T>(self, seed: T) -> Result<T::Value, Self::Error>

where T: DeserializeSeed<'de>,

Called when deserializing a variant with a single value.

fn tuple_variant<V>( self, _len: usize, visitor: V, ) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Called when deserializing a tuple-like variant.

fn struct_variant<V>( self, _fields: &'static [&'static str], visitor: V, ) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Called when deserializing a struct-like variant.

fn newtype_variant<T>(self) -> Result<T, Self::Error>

where T: Deserialize<'de>,

Called when deserializing a variant with a single value.