Struct ProgressWriter

pub struct ProgressWriter<W: Write, C: FnMut(usize)> { /* private fields */ }

Callback-based progress-monitoring writer.

Implementations

impl<W: Write, C: FnMut(usize)> ProgressWriter<W, C>

pub fn new(writer: W, callback: C) -> Self

Examples found in repository

examples/writer.rs (lines 9-12)

fn main() {
    let mut total = 0;
    let mut file = sink();
    let mut writer = ProgressWriter::new(&mut file, |progress: usize| {
        total += progress;
        println!("Written {} Kib", total / 1024);
    });


    let buffer = [0u8; 8192];
    for _ in 0..100_000 {
        writer.write(&buffer).unwrap();
    }
}

examples/threaded_writer.rs (lines 13-15)

fn main() {
    let total = Arc::new(AtomicUsize::new(0));
    let mut file = Cursor::new(Vec::new());
    let mut writer = ProgressWriter::new(&mut file, |progress: usize| {
        total.fetch_add(progress, Ordering::SeqCst);
    });

    {
        let total = total.clone();
        thread::spawn(move || {
            loop {
                println!("Written {} Kib", total.load(Ordering::SeqCst) / 1024);
                thread::sleep(Duration::from_millis(16));
            }
        });
    }

    let buffer = [0u8; 8192];
    while total.load(Ordering::SeqCst) < 1000 * 1024 * 1024 {
        writer.write(&buffer).unwrap();
    }
}

pub fn into_inner(self) -> W

Trait Implementations

impl<W: Write, C: FnMut(usize)> Write for ProgressWriter<W, C>

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

Writes a buffer into this writer, returning how many bytes were written.

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

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

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

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

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

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.