Struct image::Progress

pub struct Progress {
    current: u64,
    total: u64,
}

Represents the progress of an image operation.

Note that this is not necessarily accurate and no change to the values passed to the progress function during decoding will be considered breaking. A decoder could in theory report the progress (0, 0) if progress is unknown, without violating the interface contract of the type.

Fields

current: u64

total: u64

Implementations

impl Progress

pub(crate) fn new(current: u64, total: u64) -> Self

Create Progress. Result in invalid progress if you provide a greater current than total.

pub fn current(self) -> u64

A measure of completed decoding.

pub fn total(self) -> u64

A measure of all necessary decoding work.

This is in general greater or equal than current.

pub fn remaining(self) -> u64

Calculate a measure for remaining decoding work.

Trait Implementations

impl Clone for Progress

fn clone(&self) -> Progress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Progress

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

Formats the value using the given formatter.

impl PartialEq for Progress

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

impl Eq for Progress

impl StructuralPartialEq for Progress