Struct ffsend_api::reader::ProgressReader

pub struct ProgressReader<R> { /* fields omitted */ }

A reader wrapper, that measures the reading process for a reader with a known length.

If the reader exceeds the initially specified length, the reader will continue to allow reads. The length property will grow accordingly.

The reader will only start producing None if the wrapped reader is doing so.

Methods

impl<R: Read> ProgressReader<R>

pub fn new(inner: R) -> Result<Self, IoError> where     R: ExactLengthReader,

Wrap the given reader with an exact length, in a progress reader.

pub fn from(inner: R, len: u64) -> Self

Wrap the given reader with the given length in a progress reader.

pub fn set_reporter(&mut self, reporter: Arc<Mutex<ProgressReporter>>)

Set the reporter to report the status to.

pub fn progress(&self) -> u64

Get the current progress.

Trait Implementations

impl<R: Read> Read for ProgressReader<R>

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

Read from the encrypted file, and then the encryption tag.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> 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.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

Important traits for Bytes<R>

impl<R> Iterator for Bytes<R> where
    R: Read,  type Item = Result<u8, Error>;

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

Important traits for Chars<R>

impl<R> Iterator for Chars<R> where
    R: Read,  type Item = Result<char, CharsError>;

fn chars(self) -> Chars<Self>

Deprecated since 1.27.0

: Use str::from_utf8 instead: https://doc.rust-lang.org/nightly/std/str/struct.Utf8Error.html#examples

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

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s.

Important traits for Chain<T, U>

impl<T, U> Read for Chain<T, U> where
    T: Read,
    U: Read, 

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

Creates an adaptor which will chain this stream with another.

Important traits for Take<T>

impl<T> Read for Take<T> where
    T: Read, 

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

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

impl<R: Read> ExactLengthReader for ProgressReader<R>

fn len(&self) -> Result<u64, Error>

Get the exact length of the reader in bytes.

fn is_empty(&self) -> Result<bool, Error>

Check whehter this extact length reader is emtpy.