Struct ffsend_api::reader::ProgressWriter

pub struct ProgressWriter<W> { /* fields omitted */ }

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

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

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

Methods

impl<W: Write> ProgressWriter<W>

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

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

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

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

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.

pub fn unwrap(self) -> W

Unwrap the inner from the progress writer.

Trait Implementations

impl<W: Write> Write for ProgressWriter<W>

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

Write a buffer into this object, returning how many bytes were written.

fn flush(&mut self) -> Result<(), IoError>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?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 Write.

impl<W: Write> ExactLengthReader for ProgressWriter<W>

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.