pub struct Probe<'a, 'b> { /* private fields */ }
Expand description
A decoding probe to to look ahead what comes next.
A Probe
derefs to Decoder
and thus can be used like one without
affecting the decoder from which it was created.
Methods from Deref<Target = Decoder<'b>>§
sourcepub fn decode<T: Decode<'b, ()>>(&mut self) -> Result<T, Error>
pub fn decode<T: Decode<'b, ()>>(&mut self) -> Result<T, Error>
Decode any type that implements Decode
.
sourcepub fn decode_with<C, T: Decode<'b, C>>(
&mut self,
ctx: &mut C,
) -> Result<T, Error>
pub fn decode_with<C, T: Decode<'b, C>>( &mut self, ctx: &mut C, ) -> Result<T, Error>
Decode any type that implements Decode
.
sourcepub fn set_position(&mut self, pos: usize)
pub fn set_position(&mut self, pos: usize)
Set the current decode position.
sourcepub fn probe<'a>(&'a mut self) -> Probe<'a, 'b>
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.
sourcepub fn int(&mut self) -> Result<Int, Error>
pub fn int(&mut self) -> Result<Int, Error>
Decode a CBOR integer.
See Int
for details regarding the value range of CBOR integers.
sourcepub fn f16(&mut self) -> Result<f32, Error>
pub fn f16(&mut self) -> Result<f32, Error>
Decode a half float (f16
) and return it in an f32
.
Only available when the feature half
is present.
sourcepub fn bytes(&mut self) -> Result<&'b [u8], Error>
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.
sourcepub fn bytes_iter(&mut self) -> Result<BytesIter<'_, 'b>, Error>
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.
sourcepub fn str(&mut self) -> Result<&'b str, Error>
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.
sourcepub fn str_iter(&mut self) -> Result<StrIter<'_, 'b>, Error>
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.
sourcepub fn array(&mut self) -> Result<Option<u64>, Error>
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.
sourcepub fn array_iter<T>(&mut self) -> Result<ArrayIter<'_, 'b, T>, Error>
pub fn array_iter<T>(&mut self) -> Result<ArrayIter<'_, 'b, T>, Error>
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.
sourcepub fn array_iter_with<'a, C, T>(
&'a mut self,
ctx: &'a mut C,
) -> Result<ArrayIterWithCtx<'a, 'b, C, T>, Error>where
T: Decode<'b, C>,
pub fn array_iter_with<'a, C, T>(
&'a mut self,
ctx: &'a mut C,
) -> Result<ArrayIterWithCtx<'a, 'b, C, T>, Error>where
T: Decode<'b, C>,
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.
sourcepub fn map(&mut self) -> Result<Option<u64>, Error>
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.
sourcepub fn map_iter<K, V>(&mut self) -> Result<MapIter<'_, 'b, K, V>, Error>
pub fn map_iter<K, V>(&mut self) -> Result<MapIter<'_, 'b, K, V>, Error>
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.
sourcepub fn map_iter_with<'a, C, K, V>(
&'a mut self,
ctx: &'a mut C,
) -> Result<MapIterWithCtx<'a, 'b, C, K, V>, Error>
pub fn map_iter_with<'a, C, K, V>( &'a mut self, ctx: &'a mut C, ) -> Result<MapIterWithCtx<'a, 'b, C, K, V>, Error>
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.