Struct minicbor::Decoder

source · [−]

pub struct Decoder<'b> { /* private fields */ }

Expand description

A non-allocating CBOR decoder.

Implementations

source

impl<'b> Decoder<'b>

source

pub fn new(bytes: &'b [u8 ]) -> Self

Construct a Decoder for the given byte slice.

source

pub fn decode<T: Decode<'b>>(&mut self) -> Result<T, Error>

Decode any type that implements Decode.

source

pub fn position(&self) -> usize

Get the current decode position.

source

pub fn set_position(&mut self, pos: usize)

Set the current decode position.

source

pub fn probe<'a>(&'a mut self) -> Probe<'a, 'b>

Get a decoding probe to look ahead what is coming next.

This will not affect the decoding state of self and after the returned Probe has been dropped, decoding can continue from its current position as if probe was never called.

source

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

Decode a bool value.

source

pub fn u8(&mut self) -> Result<u8, Error>

Decode a u8 value.

source

pub fn u16(&mut self) -> Result<u16, Error>

Decode a u16 value.

source

pub fn u32(&mut self) -> Result<u32, Error>

Decode a u32 value.

source

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

Decode a u64 value.

source

pub fn i8(&mut self) -> Result<i8, Error>

Decode an i8 value.

source

pub fn i16(&mut self) -> Result<i16, Error>

Decode an i16 value.

source

pub fn i32(&mut self) -> Result<i32, Error>

Decode an i32 value.

source

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

Decode an i64 value.

source

pub fn f32(&mut self) -> Result<f32, Error>

Decode an f32 value.

source

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

Decode an f64 value.

source

pub fn char(&mut self) -> Result<char, Error>

Decode a char value.

source

pub fn bytes(&mut self) -> Result<&'b [u8 ], Error>

Decode a byte slice.

This only decodes byte slices of definite lengths. See Decoder::bytes_iter for indefinite byte slice support.

source

pub fn bytes_iter(&mut self) -> Result<BytesIter<'_, 'b>, Error>

Iterate over byte slices.

This supports indefinite byte slices by returing a byte slice on each iterator step. If a single definite slice is decoded the iterator will only yield one item.

source

pub fn str(&mut self) -> Result<&'b str, Error>

Decode a string slice.

This only decodes string slices of definite lengths. See Decoder::str_iter for indefinite string slice support.

source

pub fn str_iter(&mut self) -> Result<StrIter<'_, 'b>, Error>

Iterate over string slices.

This supports indefinite string slices by returing a string slice on each iterator step. If a single definite slice is decoded the iterator will only yield one item.

source

pub fn array(&mut self) -> Result<Option<u64>, Error>

Begin decoding an array.

CBOR arrays are heterogenous collections and may be of indefinite length. If the length is known it is returned as a Some, for indefinite arrays a None is returned.

source

pub fn array_iter<T>(&mut self) -> Result<ArrayIter<'_, 'b, T>, Error> where
T: Decode<'b>,

Iterate over all array elements.

This supports indefinite and definite length arrays and uses the Decode trait to decode each element. Consequently only homogenous arrays are supported by this method.

source

pub fn map(&mut self) -> Result<Option<u64>, Error>

Begin decoding a map.

CBOR maps are heterogenous collections (both in keys and in values) and may be of indefinite length. If the length is known it is returned as a Some, for indefinite maps a None is returned.

source

pub fn map_iter<K, V>(&mut self) -> Result<MapIter<'_, 'b, K, V>, Error> where
K: Decode<'b>,
V: Decode<'b>,

Iterate over all map entries.

This supports indefinite and definite length maps and uses the Decode trait to decode each key and value. Consequently only homogenous maps are supported by this method.

source