Enum EncodeOutcome 

pub enum EncodeOutcome {
    Consumed {
        written: usize,
    },
    NeedOutput {
        required: NonZeroUsize,
    },
}

Outcome returned by encode-side per-value hooks.

This is deliberately smaller than crate::TranscodeProgress. It only describes what happened to the current input value; the encode engine owns input/output cursor updates and progress construction.

Variants

Consumed

The current input value was consumed.

Fields

written: usize

Output units written for this value.

NeedOutput

The current input value was not consumed because output is too small.

Fields

required: NonZeroUsize

Total output units required from the current output cursor.

Implementations

impl EncodeOutcome

pub const fn consumed(written: usize) -> Self

Creates an outcome for a consumed input value.

pub const fn need_output(required: NonZeroUsize) -> Self

Creates an outcome for insufficient output capacity.

Trait Implementations

impl Clone for EncodeOutcome

fn clone(&self) -> EncodeOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EncodeOutcome

impl Debug for EncodeOutcome

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

Formats the value using the given formatter.

impl Eq for EncodeOutcome

impl Hash for EncodeOutcome

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 EncodeOutcome

fn eq(&self, other: &EncodeOutcome) -> 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 EncodeOutcome