Enum DecodeInvalidAction 

#[non_exhaustive]
pub enum DecodeInvalidAction<Value> {
    Reject,
    Skip {
        consumed: NonZeroUsize,
    },
    Emit {
        value: Value,
        consumed: NonZeroUsize,
    },
}

Action selected after a codec reports invalid encoded input.

While the stream is open, incomplete input is not an invalid-input policy action. Codecs report it with crate::DecodeFailure::Incomplete, and the decode engine converts it into crate::TranscodeStatus::NeedInput. After upstream EOF, crate::Transcoder::transcode_eof asks the codec to resolve a trailing incomplete sequence through crate::Codec::decode_eof; if it remains incomplete, the engine calls crate::engine::DecodeIncompleteAction through crate::engine::TranscodeDecodeHooks::handle_incomplete_decode.

Type Parameters

• Value: Decoded output value type.

Examples

use core::num::NonZeroUsize;

use qubit_codec::engine::DecodeInvalidAction;

let action = DecodeInvalidAction::<u8>::Skip {
    consumed: NonZeroUsize::new(1).unwrap(),
};
assert!(matches!(action, DecodeInvalidAction::Skip { .. }));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Reject

Reject the current invalid input.

The decode engine reports the original codec decode error as crate::TranscodeDecodeError::Domain at the current input index.

Skip

Consume invalid input without producing output.

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 replacement value and consume source units.

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 DecodeInvalidAction<Value>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Value: Copy> Copy for DecodeInvalidAction<Value>

impl<Value: Debug> Debug for DecodeInvalidAction<Value>

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

Formats the value using the given formatter.

impl<Value: Eq> Eq for DecodeInvalidAction<Value>

impl<Value: Hash> Hash for DecodeInvalidAction<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 DecodeInvalidAction<Value>

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

Equality operator ==.

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

Inequality operator !=.

impl<Value: PartialEq> StructuralPartialEq for DecodeInvalidAction<Value>