Struct minicbor_io::AsyncReader

pub struct AsyncReader<R> { /* private fields */ }

Wraps an AsyncRead and reads length-delimited CBOR values.

Requires cargo feature "async-io".

Implementations

impl<R> AsyncReader<R>

pub fn new(reader: R) -> Self

Create a new reader with a max. buffer size of 512KiB.

pub fn with_buffer(reader: R, buffer: Vec<u8>) -> Self

Create a new reader with a max. buffer size of 512KiB.

pub fn set_max_len(&mut self, val: u32)

Set the max. buffer size in bytes.

If length values greater than this are decoded, an Error::InvalidLen will be returned.

pub fn reader(&self) -> &R

Get a reference to the inner reader.

pub fn reader_mut(&mut self) -> &mut R

Get a mutable reference to the inner reader.

pub fn into_parts(self) -> (R, Vec<u8>)

Deconstruct this reader into the inner reader and the buffer.

impl<R: AsyncRead + Unpin> AsyncReader<R>

pub async fn read<'a, T: Decode<'a, ()>>(
    &'a mut self
) -> Result<Option<T>, Error>

Read the next CBOR value and decode it.

The value is assumed to be preceded by a u32 (4 bytes in network byte order) denoting the length of the CBOR item in bytes.

Reading 0 bytes when decoding the length prefix results in Ok(None), otherwise either Some value or an error is returned.

Cancellation

The future returned by AsyncReader::read can be dropped while still pending. Subsequent calls to AsyncReader::read will resume reading where the previous future left off.

pub async fn read_with<'a, C, T: Decode<'a, C>>(
    &'a mut self,
    ctx: &mut C
) -> Result<Option<T>, Error>

Like AsyncReader::read but accepting a user provided decoding context.

Trait Implementations

impl<R: Debug> Debug for AsyncReader<R>

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

Formats the value using the given formatter.