Struct read_progress::ReaderWithSize

pub struct ReaderWithSize<R: Read> { /* private fields */ }

A wrapper for a Read that monitors how many bytes have been read, and how many are to go

Implementations

impl<R: Read> ReaderWithSize<R>

pub fn new(total_size: usize, inner: R) -> Self

Create a ReaderWithSize from inner presuming the total number of bytes is total_size.

pub fn into_inner(self) -> R

Consumer this, and return the inner Read.

pub fn inner(&self) -> &R

A reference to the inner Read.

impl ReaderWithSize<File>

pub fn from_path(path: impl Into<PathBuf>) -> Result<Self, Error>

Given a path, create a ReaderWithSize based on that file size

pub fn from_file(file: File) -> Result<Self, Error>

Given a file, create a ReaderWithSize based on that file size

Trait Implementations

impl<R: Read> Read for ReaderWithSize<R>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<R: Read> ReadWithSize for ReaderWithSize<R>

fn total_read(&self) -> usize

The total number of bytes that have been read from this reader

fn assummed_total_size(&self) -> usize

The assumed total number of bytes in this reader, created when this object was created.

fn fraction(&self) -> f64

How far along this reader have we read? What fraction have we read? May be >1.0 if the initial provided assumed total size was wrong.

fn read_start_time(&self) -> Option<Instant>

When did this reader start reading None if it hasn’t started

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

Estimated Time to Arrival, at this rate, what’s the predicted end time None if it hasn’t started yet

fn etc(&self) -> Option<Instant>

Estimated Time to Completion, at this rate, how long before it is complete None if it hasn’t started yet

fn est_total_time(&self) -> Option<Duration>

Total estimated duration this reader will run for. None if it hasn’t started yet

fn bytes_per_sec(&self) -> Option<f64>

How many bytes per second are being read. None if it hasn’t started