Struct Progress 

pub struct Progress {
    pub logical_bytes: u64,
    pub wire_bytes: u64,
    pub bytes_total: u64,
    pub chunks: u64,
    pub chunks_compressed: u64,
    pub chunks_skipped: u64,
    pub chunks_zero: u64,
    pub chunks_reused: u64,
    pub compressor_runs: u64,
    pub files_completed: u64,
    pub files_total: u64,
    pub elapsed: Duration,
}

A point-in-time view of a transfer.

Fields

logical_bytes: u64

Payload bytes transferred, measured as they exist on disk.

wire_bytes: u64

Bytes actually put on the wire.

bytes_total: u64

chunks: u64

chunks_compressed: u64

chunks_skipped: u64

chunks_zero: u64

chunks_reused: u64

Chunks the receiver already had; the payload never crossed the wire.

compressor_runs: u64

Chunks handed to the compressor. Compare with chunks_compressed: the difference is compression work whose output was discarded.

files_completed: u64

files_total: u64

elapsed: Duration

Implementations

impl Progress

pub fn throughput(&self) -> f64

Effective throughput in bytes/sec, measured against logical bytes. This is the number a user cares about: how fast their data moved, not how many packets it took.

pub fn wire_throughput(&self) -> f64

Throughput measured against bytes actually sent.

pub fn compression_ratio(&self) -> f64

Compression ratio achieved, logical / wire. 1.0 means no saving.

pub fn fraction(&self) -> f64

Fraction of the transfer complete, 0.0..=1.0.

pub fn eta(&self) -> Option<Duration>

Estimated time remaining, from the average rate so far.

Trait Implementations

impl Clone for Progress

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Progress

impl Debug for Progress

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

Formats the value using the given formatter.

impl Display for Progress

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

Formats the value using the given formatter.

impl Eq for Progress

impl PartialEq for Progress

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Progress