Struct DecodeContext 

pub struct DecodeContext { /* private fields */ }

Context for one codec decode attempt inside a buffered decoder engine.

Implementations

impl DecodeContext

pub const fn new( input_start: usize, input_index: usize, output_start: usize, output_index: usize, available: usize, ) -> Self

Creates a decode context.

Parameters

• input_start: Absolute source index where this transcode call starts.
• input_index: Absolute source index where the attempted value starts.
• output_start: Absolute output index where this transcode call starts.
• output_index: Absolute output index where the next value would be written.
• available: Units visible to the codec from input_index.

Returns

Returns a decode context.

Panics

Panics when input_index < input_start or output_index < output_start.

pub const fn input_start(self) -> usize

Returns the absolute source index where this transcode call starts.

Returns

Returns the input start index.

pub const fn input_index(self) -> usize

Returns the absolute source index where the attempted value starts.

Returns

Returns the current input index.

pub const fn output_start(self) -> usize

Returns the absolute output index where this transcode call starts.

Returns

Returns the output start index.

pub const fn output_index(self) -> usize

Returns the absolute output index where the next decoded value would be written.

Returns

Returns the current output index.

pub const fn available(self) -> usize

Returns units visible to the codec from Self::input_index.

Returns

Returns the available input-unit count.

pub const fn input_used(self) -> usize

Returns input units consumed since this transcode call started.

Returns

Returns input_index - input_start.

pub const fn output_written(self) -> usize

Returns output values written since this transcode call started.

Returns

Returns output_index - output_start.

Trait Implementations

impl Clone for DecodeContext

fn clone(&self) -> DecodeContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DecodeContext

impl Debug for DecodeContext

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

Formats the value using the given formatter.

impl Eq for DecodeContext

impl Hash for DecodeContext

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DecodeContext

fn eq(&self, other: &DecodeContext) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DecodeContext