Enum TranscodeStatus 

pub enum TranscodeStatus {
    Complete,
    NeedInput {
        input_index: usize,
        required: NonZeroUsize,
        available: usize,
    },
    NeedOutput {
        output_index: usize,
        required: NonZeroUsize,
        available: usize,
    },
}

Reports why a crate::Transcoder stopped converting input.

Variants

Complete

All currently supplied input was consumed.

NeedInput

More input is needed to complete the next output value.

The transcoder does not consume incomplete input tails. The caller should preserve input[input_index..], refill the input buffer when more data is available, or apply its EOF policy when the upstream source is closed. Calling crate::Transcoder::finish does not pass this tail back to the transcoder.

• input_index: Absolute input index where input ended while decoding.
• required: Total input units required from the current input position.
• available: Number of input units currently available from the current input position.

Fields

input_index: usize

Absolute input index where input ended.

required: NonZeroUsize

Total input units required from the current input position.

available: usize

Number of input units currently available.

NeedOutput

More output capacity is needed before conversion can continue.

• output_index: Absolute output index where output ended while decoding.
• required: Total output units required from the current output position.
• available: Number of output units currently available from the current output position.

Fields

output_index: usize

Absolute output index where output ended.

required: NonZeroUsize

Total output units required from the current output position.

available: usize

Number of output units currently available.

Implementations

impl TranscodeStatus

pub const fn need_input( input_index: usize, required: NonZeroUsize, available: usize, ) -> Self

Creates a status that requests more input.

Parameters

• input_index: Absolute input boundary where conversion stopped.
• required: Total input units required from the current input position.
• available: Input units currently available at the boundary.

Returns

Returns a TranscodeStatus::NeedInput value.

pub const fn need_output( output_index: usize, required: NonZeroUsize, available: usize, ) -> Self

Creates a status that requests more output capacity.

Parameters

• output_index: Absolute output boundary where conversion stopped.
• required: Total output units required from the current output position.
• available: Output units currently available at the boundary.

Returns

Returns a TranscodeStatus::NeedOutput value.

Trait Implementations

impl Clone for TranscodeStatus

fn clone(&self) -> TranscodeStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TranscodeStatus

impl Debug for TranscodeStatus

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

Formats the value using the given formatter.

impl Eq for TranscodeStatus

impl PartialEq for TranscodeStatus

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