Struct Decoder 

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

Reads one message from its frames.

Implementations

impl<'f> Decoder<'f>

pub fn new(frames: &'f [Bytes]) -> Self

A decoder over a message’s frames (frame 0 is the msgpack buffer).

Panics

If frames is empty.

pub fn finish(&self) -> Result<()>

Fail unless the whole msgpack buffer was consumed.

pub fn peek_tag(&self) -> Result<&'f str>

The tag of the tagged array struct that comes next, without consuming it.

pub fn peek_kind(&self) -> Result<Kind>

The type of the next value, without consuming it.

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

Consume a nil if the next value is one.

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

Read a boolean.

pub fn integer(&mut self) -> Result<Integer>

Read an integer in any format.

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

Read a float. Integers are accepted, as msgspec does for float fields.

pub fn str(&mut self) -> Result<&'f str>

Read a string, borrowed from the msgpack buffer.

pub fn bin(&mut self) -> Result<Bytes>

Read a binary value, sharing the msgpack buffer.

pub fn array_len(&mut self) -> Result<usize>

Read an array header and return its length.

pub fn map_len(&mut self) -> Result<usize>

Read a map header and return its number of entries.

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

Read an extension value, sharing the msgpack buffer.

pub fn skip(&mut self) -> Result<()>

Skip one value of any type.

Trait Implementations

impl<'f> Clone for Decoder<'f>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'f> Debug for Decoder<'f>

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

Formats the value using the given formatter.