Struct librsyncr::ProgressReader

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

A Read adaptor that calls a callback every so often as data is read from it so that the progress of an operation can be reported.

Methods

impl<R: Read> ProgressReader<R>

pub fn new(inner: R, total_len: u64, callback: Box<dyn FnMut(f32)>) -> Self

Creates a new ProgressReader. The total_len is the total number of bytes in the operation and the callback is the function to be called after every (currently) 1% has been read.

pub fn read_len(&self) -> u64

Returns the number of bytes that have been read so far.

Trait Implementations

impl<R: Read> Read for ProgressReader<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.

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.

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

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

fn bytes(self) -> Bytes<Self>

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

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

Creates an adaptor which will chain this stream with another.

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

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