Struct TranscodeProgress 

pub struct TranscodeProgress { /* private fields */ }

Counts how much work a crate::Transcoder completed before returning.

Implementations

impl TranscodeProgress

pub const fn new(status: TranscodeStatus, read: usize, written: usize) -> Self

Creates a progress value.

Parameters

• status: The reason conversion stopped.
• read: Number of input units consumed from the call’s input index.
• written: Number of output units written from the call’s output index.

Returns

Returns a progress value carrying the supplied counters.

pub const fn complete(read: usize, written: usize) -> Self

Creates a completed progress value.

Parameters

• read: Number of consumed input units.
• written: Number of produced output units.

Returns

Returns a progress value whose status is TranscodeStatus::Complete.

pub const fn need_input( input_index: usize, additional: NonZeroUsize, available: usize, read: usize, written: usize, ) -> Self

Creates progress that stopped because more input is needed.

Parameters

• input_index: Absolute input boundary where conversion stopped.
• additional: Additional input units required to continue.
• available: Input units currently available at the boundary.
• read: Number of consumed input units.
• written: Number of produced output units.

Returns

Returns a progress value with TranscodeStatus::NeedInput.

pub const fn need_output( output_index: usize, additional: NonZeroUsize, available: usize, read: usize, written: usize, ) -> Self

Creates progress that stopped because more output capacity is needed.

Parameters

• output_index: Absolute output boundary where conversion stopped.
• additional: Additional output units required to continue.
• available: Output units currently available at the boundary.
• read: Number of consumed input units.
• written: Number of produced output units.

Returns

Returns a progress value with TranscodeStatus::NeedOutput.

pub const fn status(self) -> TranscodeStatus

Returns the status that stopped conversion.

Returns

Returns the stored TranscodeStatus.

pub const fn is_complete(self) -> bool

Returns whether conversion consumed all currently supplied input.

Returns

Returns true when the stored status is TranscodeStatus::Complete.

pub const fn is_need_input(self) -> bool

Returns whether conversion stopped because more input is needed.

Returns

Returns true when the stored status is TranscodeStatus::NeedInput.

pub const fn is_need_output(self) -> bool

Returns whether conversion stopped because more output capacity is needed.

Returns

Returns true when the stored status is TranscodeStatus::NeedOutput.

pub const fn read(self) -> usize

Returns the number of input units consumed by the call.

Returns

Returns a count relative to the input index passed to the conversion call.

pub const fn written(self) -> usize

Returns the number of output units written by the call.

Returns

Returns a count relative to the output index passed to the conversion call.

Trait Implementations

impl Clone for TranscodeProgress

fn clone(&self) -> TranscodeProgress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TranscodeProgress

impl Debug for TranscodeProgress

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

Formats the value using the given formatter.

impl Eq for TranscodeProgress

impl PartialEq for TranscodeProgress

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