Struct CoderProgress 

pub struct CoderProgress { /* private fields */ }

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

Implementations

impl CoderProgress

pub const fn new( status: CoderStatus, read: usize, written: usize, ) -> CoderProgress

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) -> CoderProgress

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 CoderStatus::Complete.

pub const fn status(self) -> CoderStatus

Returns the status that stopped conversion.

Returns

Returns the stored CoderStatus.

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.

pub const fn required(self) -> usize

Returns the additional unit count required by the reported status.

Returns

Returns 0 when conversion completed.

pub const fn index(self) -> Option<usize>

Returns the absolute boundary index associated with this status, if any.

• For CoderStatus::NeedInput, returns input_index.
• For CoderStatus::NeedOutput, returns output_index.
• For CoderStatus::Complete, returns None.

pub const fn available(self) -> usize

Returns the number of available units at the reported status boundary.

Returns

Returns 0 when conversion completed.

Trait Implementations

impl Clone for CoderProgress

fn clone(&self) -> CoderProgress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoderProgress

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

Formats the value using the given formatter.

impl PartialEq for CoderProgress

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

impl Eq for CoderProgress

impl StructuralPartialEq for CoderProgress