Struct cursive::utils::ProgressReader
source · pub struct ProgressReader<R: Read> { /* private fields */ }
Expand description
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::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
sourceimpl<R: Read> ProgressReader<R>
impl<R: Read> ProgressReader<R>
sourcepub fn new(counter: Counter, reader: R) -> Self
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.
sourcepub fn deconstruct(self) -> (R, Counter)
pub fn deconstruct(self) -> (R, Counter)
Unwraps this ProgressReader
, returning the reader and counter.
Trait Implementations
sourceimpl<R: Clone + Read> Clone for ProgressReader<R>
impl<R: Clone + Read> Clone for ProgressReader<R>
sourcefn clone(&self) -> ProgressReader<R> ⓘ
fn clone(&self) -> ProgressReader<R> ⓘ
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresourceimpl<R: Debug + Read> Debug for ProgressReader<R>
impl<R: Debug + Read> Debug for ProgressReader<R>
sourceimpl<R: Read> Read for ProgressReader<R>
impl<R: Read> Read for ProgressReader<R>
sourcefn read(&mut self, buf: &mut [u8]) -> Result<usize>
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. Read more
1.36.0 · sourcefn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
Like
read
, except that it reads into a slice of buffers. Read moresourcefn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)1.0.0 · sourcefn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
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
. Read more1.0.0 · sourcefn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
Read all bytes until EOF in this source, appending them to
buf
. Read more1.6.0 · sourcefn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
Read the exact number of bytes required to fill
buf
. Read moresourcefn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
🔬This is a nightly-only experimental API. (
read_buf
)Pull some bytes from this source into the specified buffer. Read more
sourcefn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
🔬This is a nightly-only experimental API. (
read_buf
)Read the exact number of bytes required to fill
cursor
. Read more1.0.0 · sourcefn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Creates a “by reference” adaptor for this instance of
Read
. Read moreAuto Trait Implementations
impl<R> RefUnwindSafe for ProgressReader<R>where
R: RefUnwindSafe,
impl<R> Send for ProgressReader<R>where
R: Send,
impl<R> Sync for ProgressReader<R>where
R: Sync,
impl<R> Unpin for ProgressReader<R>where
R: Unpin,
impl<R> UnwindSafe for ProgressReader<R>where
R: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more