Enum DecodeAction 

pub enum DecodeAction<Value> {
    NeedInput {
        required_total: usize,
    },
    Skip {
        consumed: NonZeroUsize,
    },
    Emit {
        value: Value,
        consumed: NonZeroUsize,
    },
}

Action selected after a codec decode attempt fails during transcode.

Type Parameters

• Value: Decoded output value type.

Variants

NeedInput

More source units are needed before a value can be produced.

When returned by a decode hook, required_total must be greater than the hook context’s available input count. Returning a value that is already satisfied is a hook contract violation and panics in the engine.

Fields

required_total: usize

Total units required from the current value start.

Skip

Consume invalid input without producing output.

When returned by a decode hook, consumed must not exceed the hook context’s available input count. Over-consuming is a hook contract violation and panics in the engine.

Fields

consumed: NonZeroUsize

Source units to consume.

Emit

Produce one value and consume source units.

When returned by a decode hook, consumed must not exceed the hook context’s available input count. Over-consuming is a hook contract violation and panics in the engine.

Fields

value: Value

Value to write to the output buffer.

consumed: NonZeroUsize

Source units to consume.

Trait Implementations

impl<Value: Clone> Clone for DecodeAction<Value>

fn clone(&self) -> DecodeAction<Value>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Value: Copy> Copy for DecodeAction<Value>

impl<Value: Debug> Debug for DecodeAction<Value>

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

Formats the value using the given formatter.

impl<Value: Eq> Eq for DecodeAction<Value>

impl<Value: Hash> Hash for DecodeAction<Value>

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<Value: PartialEq> PartialEq for DecodeAction<Value>

fn eq(&self, other: &DecodeAction<Value>) -> 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<Value> StructuralPartialEq for DecodeAction<Value>