Skip to main content

FrameDriver

Struct FrameDriver 

Source
pub struct FrameDriver<D> { /* private fields */ }
Expand description

Bounded, terminal-on-malformation driver for one incremental decoder.

Implementations§

Source§

impl<D: FrameDecoder> FrameDriver<D>

Source

pub fn new( decoder: D, max_retained_bytes: RetainedBytes, ) -> Result<Self, FrameDecodeError<D::Error>>

Wraps a decoder if its initial retained memory is within the bound.

Source

pub fn feed(&mut self, bytes: &[u8]) -> Result<(), FrameDecodeError<D::Error>>

Admits a borrowed byte chunk or leaves it entirely with the caller.

Source

pub fn next_frame( &mut self, ) -> Result<Option<D::Frame>, FrameDecodeError<D::Error>>

Extracts at most one complete opaque frame.

Source

pub fn retained_bytes(&self) -> RetainedBytes

Returns variable memory retained by the adapter decoder.

Source

pub const fn is_failed(&self) -> bool

Returns whether a terminal adapter or accounting failure occurred.

Source

pub fn into_decoder(self) -> D

Recovers the protocol-owned decoder.

Trait Implementations§

Source§

impl<D: FrameDecoder> Debug for FrameDriver<D>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<D> Freeze for FrameDriver<D>
where D: Freeze,

§

impl<D> RefUnwindSafe for FrameDriver<D>
where D: RefUnwindSafe,

§

impl<D> Send for FrameDriver<D>
where D: Send,

§

impl<D> Sync for FrameDriver<D>
where D: Sync,

§

impl<D> Unpin for FrameDriver<D>
where D: Unpin,

§

impl<D> UnsafeUnpin for FrameDriver<D>
where D: UnsafeUnpin,

§

impl<D> UnwindSafe for FrameDriver<D>
where D: 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>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.