Struct cursive::utils::ProgressReader
source · [−]pub struct ProgressReader<R> where
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_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
sourceimpl<R> ProgressReader<R> where
R: Read,
impl<R> ProgressReader<R> where
R: Read,
sourcepub fn new(counter: Counter, reader: R) -> ProgressReader<R>ⓘNotable traits for ProgressReader<R>impl<R> Read for ProgressReader<R> where
R: Read,
pub fn new(counter: Counter, reader: R) -> ProgressReader<R>ⓘNotable traits for ProgressReader<R>impl<R> Read for ProgressReader<R> where
R: Read,
R: Read,
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 for ProgressReader<R> where
R: Clone + Read,
impl<R> Clone for ProgressReader<R> where
R: Clone + Read,
sourcefn clone(&self) -> ProgressReader<R>ⓘNotable traits for ProgressReader<R>impl<R> Read for ProgressReader<R> where
R: Read,
fn clone(&self) -> ProgressReader<R>ⓘNotable traits for ProgressReader<R>impl<R> Read for ProgressReader<R> where
R: Read,
R: Read,
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 more
sourceimpl<R> Debug for ProgressReader<R> where
R: Debug + Read,
impl<R> Debug for ProgressReader<R> where
R: Debug + Read,
sourceimpl<R> Read for ProgressReader<R> where
R: Read,
impl<R> Read for ProgressReader<R> where
R: Read,
sourcefn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
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 more
sourcefn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
can_vector
)Determines if this Read
er has an efficient read_vectored
implementation. Read more
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 more
1.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 more
1.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 more
sourcefn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>
read_buf
)Pull some bytes from this source into the specified buffer. Read more
sourcefn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>
read_buf
)Read the exact number of bytes required to fill buf
. Read more
1.0.0 · sourcefn by_ref(&mut self) -> &mut Self
fn by_ref(&mut self) -> &mut Self
Creates a “by reference” adaptor for this instance of Read
. Read more
1.0.0 · sourcefn bytes(self) -> Bytes<Self>ⓘNotable traits for Bytes<R>impl<R> Iterator for Bytes<R> where
R: Read, type Item = Result<u8, Error>;
fn bytes(self) -> Bytes<Self>ⓘNotable traits for Bytes<R>impl<R> Iterator for Bytes<R> where
R: Read, type Item = Result<u8, Error>;
R: Read, type Item = Result<u8, Error>;
Auto 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 T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
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
sourceimpl<R> TermRead for R where
R: Read + TermReadEventsAndRaw,
impl<R> TermRead for R where
R: Read + TermReadEventsAndRaw,
sourcefn events(self) -> Events<R>ⓘNotable traits for Events<R>impl<R> Iterator for Events<R> where
R: Read, type Item = Result<Event, Error>;
fn events(self) -> Events<R>ⓘNotable traits for Events<R>impl<R> Iterator for Events<R> where
R: Read, type Item = Result<Event, Error>;
R: Read, type Item = Result<Event, Error>;
An iterator over input events.
sourceimpl<R> TermReadEventsAndRaw for R where
R: Read,
impl<R> TermReadEventsAndRaw for R where
R: Read,
sourcefn events_and_raw(self) -> EventsAndRaw<R>ⓘNotable traits for EventsAndRaw<R>impl<R> Iterator for EventsAndRaw<R> where
R: Read, type Item = Result<(Event, Vec<u8, Global>), Error>;
fn events_and_raw(self) -> EventsAndRaw<R>ⓘNotable traits for EventsAndRaw<R>impl<R> Iterator for EventsAndRaw<R> where
R: Read, type Item = Result<(Event, Vec<u8, Global>), Error>;
R: Read, type Item = Result<(Event, Vec<u8, Global>), Error>;
An iterator over input events and the bytes that define them.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more