Struct cursive_core::utils::ProgressReader

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

Wrapper around a Read that reports the progress made.

Used to monitor a file downloading or other slow IO task in a progress bar.

Examples

use std::io::Read;
use cursive_core::utils::{Counter, ProgressReader};

// Read a file and report the progress
let file = std::fs::File::open("large_file").unwrap();
let counter = Counter::new(0);
let mut reader = ProgressReader::new(counter.clone(), file);

std::thread::spawn(move || {
    // Left as an exercise: use an AtomicBool for a stop condition!
    loop {
        let progress = counter.get();
        println!("Read {} bytes so far", progress);
    }
});

// As we read data, the counter will be updated and the control thread
// will monitor the progress.
let mut buffer = Vec::new();
reader.read_to_end(&mut buffer).unwrap();

Implementations

impl<R: Read> ProgressReader<R>

pub fn new(counter: Counter, reader: R) -> Self

Creates a new ProgressReader around reader.

counter will be updated with the number of bytes read.

You should make sure the progress bar knows how many bytes should be received.

pub fn deconstruct(self) -> (R, Counter)

Unwraps this ProgressReader, returning the reader and counter.

Trait Implementations

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

pub fn clone(&self) -> ProgressReader<R>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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

pub 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.

pub fn read_vectored(
    &mut self,
    bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

pub fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

pub 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.

pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

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

Read the exact number of bytes required to fill buf.

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

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

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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