Decoder

Struct Decoder 

Source
pub struct Decoder<U: UPrim> { /* private fields */ }
Expand description

An incremental varint decoder for reading varints byte-by-byte from streams.

This is useful when reading from async streams where you receive one byte at a time and need to know when the varint is complete while also building up the decoded value.

§Example

use commonware_codec::varint::Decoder;

let mut decoder = Decoder::<u32>::new();

// Feed bytes one at a time (e.g., from a stream)
// 300 encodes as [0xAC, 0x02]
assert_eq!(decoder.feed(0xAC).unwrap(), None); // continuation bit set, need more
assert_eq!(decoder.feed(0x02).unwrap(), Some(300)); // complete!

Implementations§

Source§

impl<U: UPrim> Decoder<U>

Source

pub fn new() -> Self

Creates a new decoder ready to receive bytes.

Source

pub fn feed(&mut self, byte: u8) -> Result<Option<U>, Error>

Feeds a byte to the decoder.

Returns:

  • Ok(Some(value)) when the varint is complete
  • Ok(None) when more bytes are needed
  • Err(InvalidVarint) if the varint is malformed (overflow or invalid encoding)

Trait Implementations§

Source§

impl<U: Clone + UPrim> Clone for Decoder<U>

Source§

fn clone(&self) -> Decoder<U>

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl<U: Debug + UPrim> Debug for Decoder<U>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<U: UPrim> Default for Decoder<U>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<U> Freeze for Decoder<U>
where U: Freeze,

§

impl<U> RefUnwindSafe for Decoder<U>
where U: RefUnwindSafe,

§

impl<U> Send for Decoder<U>
where U: Send,

§

impl<U> Sync for Decoder<U>
where U: Sync,

§

impl<U> Unpin for Decoder<U>
where U: Unpin,

§

impl<U> UnwindSafe for Decoder<U>
where U: UnwindSafe,

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

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

Performs the conversion.