Skip to main content

DecodeStep

Struct DecodeStep 

Source
pub struct DecodeStep {
    pub consumed: usize,
    pub written: usize,
    pub finished: bool,
    pub needs_input: bool,
}
Expand description

A single incremental decode step. Retain input after consumed, and consume output before calling again. A single coding stages nothing internally; a chain stages between its codings in buffers allocated at construction.

A step returns for exactly one of three reasons, and says which:

finishedneeds_inputstopped becausenext
truefalsethe body is completenothing; reset for another body
falsetrueevery input byte the decoder can use is usedmore input, or end = true
falsefalseoutput is full (written == output.len())drain, then call again

So a host sizes its scratch buffer from the third case - it filled the buffer - and reads from the transport only in the second. The unconsumed tail of the input in the second case is a partial header or trailer the decoder cannot use yet; keep it and append to it.

Fields§

§consumed: usize§written: usize§finished: bool§needs_input: bool

The decoder stopped for input, not for output space. See the table.

Trait Implementations§

Source§

impl Debug for DecodeStep

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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.