Enum EncodeUnencodableAction 

#[non_exhaustive]
pub enum EncodeUnencodableAction<Value> {
    Reject,
    Skip,
    Replace {
        value: Value,
    },
}

Action selected after a codec reports an unencodable input value.

Normal encodable values are handled by the encode engine itself. Hook implementations return this action only for values outside the codec’s encodable domain.

Type Parameters

• Value: Logical input value type accepted by the codec.

Examples

use qubit_codec::engine::EncodeUnencodableAction;

let action = EncodeUnencodableAction::replace(0_u8);
assert!(matches!(action, EncodeUnencodableAction::Replace { value: 0 }));

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 input value.

The encode engine reports crate::TranscodeEncodeError::Unencodable at the current input index.

Skip

Consume the current input value without producing output.

Replace

Encode a replacement value and consume the current input value.

The replacement must be encodable by the same codec. Returning an unencodable replacement is a hook contract violation and panics in the encode engine.

Fields

value: Value

Replacement value to encode.

Implementations

impl<Value> EncodeUnencodableAction<Value>

pub const fn reject() -> Self

Creates a reject action.

Returns

Returns Self::Reject.

pub const fn replace(value: Value) -> Self

Creates a replacement action.

Parameters

• value: Replacement value to encode.

Returns

Returns Self::Replace carrying value.

Trait Implementations

impl<Value: Clone> Clone for EncodeUnencodableAction<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 EncodeUnencodableAction<Value>

impl<Value: Debug> Debug for EncodeUnencodableAction<Value>

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

Formats the value using the given formatter.

impl<Value: Eq> Eq for EncodeUnencodableAction<Value>

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

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

Equality operator ==.

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

Inequality operator !=.

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