Struct minicbor_io::Reader

source ·
pub struct Reader<R> { /* private fields */ }
Expand description

Wraps a std::io::Read and reads length-delimited CBOR values.

Implementations§

source§

impl<R> Reader<R>

source

pub fn new(reader: R) -> Self

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

source

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

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

source

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.

source

pub fn reader(&self) -> &R

Get a reference to the inner reader.

source

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

Get a mutable reference to the inner reader.

source

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

Deconstruct this reader into the inner reader and the buffer.

source§

impl<R: Read> Reader<R>

source

pub 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.

source

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

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

Trait Implementations§

source§

impl<R: Debug> Debug for Reader<R>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R> Freeze for Reader<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for Reader<R>
where R: RefUnwindSafe,

§

impl<R> Send for Reader<R>
where R: Send,

§

impl<R> Sync for Reader<R>
where R: Sync,

§

impl<R> Unpin for Reader<R>
where R: Unpin,

§

impl<R> UnwindSafe for Reader<R>
where R: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.