[][src]Struct read_progress::ReaderWithSize

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

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


impl<R: Read> ReaderWithSize<R>[src]

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

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

pub fn total_read(&self) -> usize[src]

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

pub fn assummed_total_size(&self) -> usize[src]

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

pub fn fraction(&self) -> f64[src]

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.

pub fn into_inner(self) -> R[src]

Consumer this, and return the inner Read.

pub fn inner(&self) -> &R[src]

A reference to the inner Read.

impl ReaderWithSize<File>[src]

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

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

Trait Implementations

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

Read from this, storing how many bytes were read

Auto Trait Implementations

impl<R> RefUnwindSafe for ReaderWithSize<R> where
    R: RefUnwindSafe

impl<R> Send for ReaderWithSize<R> where
    R: Send

impl<R> Sync for ReaderWithSize<R> where
    R: Sync

impl<R> Unpin for ReaderWithSize<R> where
    R: Unpin

impl<R> UnwindSafe for ReaderWithSize<R> where
    R: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.