Struct ReaderProgress 

pub struct ReaderProgress {
    pub bytes_read: u64,
    pub total_bytes: Option<u64>,
}

A snapshot of a reader’s consumption progress, obtained via PbfReader::progress (or IterableReader::progress / any Deref-inheriting reader with sequential semantics). Callers can poll it at their own rate (e.g. every 250 ms) to render a progress bar.

Progress is byte-based: bytes_read is the stream position and is only meaningful for sequential reads — random-access readers (CachedReader after a seek) report the position of the current seek, not a global progress.

Fields

bytes_read: u64

Bytes consumed from the stream so far (equals the total length at EOF).

total_bytes: Option<u64>

Total stream length; None when unknown (e.g. non-file streams).

Implementations

impl ReaderProgress

pub fn fraction(&self) -> Option<f64>

Fraction of the stream consumed, None when the total length is unknown.

pub fn percent(&self) -> Option<f64>

Percentage of the stream consumed, None when the total length is unknown.

Trait Implementations

impl Clone for ReaderProgress

fn clone(&self) -> ReaderProgress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ReaderProgress

impl Debug for ReaderProgress

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

Formats the value using the given formatter.

impl Eq for ReaderProgress

impl PartialEq for ReaderProgress

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReaderProgress