Struct ciborium_ll::Decoder

pub struct Decoder<R: Read> { /* private fields */ }

A decoder for deserializing CBOR items

This decoder manages the low-level decoding of CBOR items into Header objects. It also contains utility functions for parsing segmented bytes and text inputs.

Implementations

impl<R: Read> Decoder<R>

pub fn pull(&mut self) -> Result<Header, Error<R::Error>>

Pulls the next header from the input

pub fn push(&mut self, item: Header)

Push a single header into the input buffer

Panics

This function panics if called while there is already a header in the input buffer. You should take care to call this function only after pulling a header to ensure there is nothing in the input buffer.

pub fn offset(&mut self) -> usize

Gets the current byte offset into the stream

The offset starts at zero when the decoder is created. Therefore, if bytes were already read from the reader before the decoder was created, you must account for this.

pub fn bytes(&mut self, len: Option<usize>) -> Segments<'_, R, Bytes>

Process an incoming bytes item

In CBOR, bytes can be segmented. The logic for this can be a bit tricky, so we encapsulate that logic using this function. This function MUST be called immediately after first pulling a Header::Bytes(len) from the wire and len must be provided to this function from that value.

The buf parameter provides a buffer used when reading in the segmented bytes. A large buffer will result in fewer calls to read incoming bytes at the cost of memory usage. You should consider this trade off when deciding the size of your buffer.

pub fn text(&mut self, len: Option<usize>) -> Segments<'_, R, Text>

Process an incoming text item

In CBOR, text can be segmented. The logic for this can be a bit tricky, so we encapsulate that logic using this function. This function MUST be called immediately after first pulling a Header::Text(len) from the wire and len must be provided to this function from that value.

The buf parameter provides a buffer used when reading in the segmented text. A large buffer will result in fewer calls to read incoming bytes at the cost of memory usage. You should consider this trade off when deciding the size of your buffer.

Trait Implementations

impl<R: Read> From<R> for Decoder<R>

fn from(value: R) -> Self

Converts to this type from the input type.

impl<R: Read> Read for Decoder<R>

type Error = <R as Read>::Error

The error type

fn read_exact(&mut self, data: &mut [u8]) -> Result<(), Self::Error>

Reads exactly data.len() bytes or fails