Trait indicatif::ProgressIterator
source · [−]pub trait ProgressIterator where
Self: Sized + Iterator, {
fn progress_with(self, progress: ProgressBar) -> ProgressBarIter<Self>ⓘNotable traits for ProgressBarIter<T>impl<S, T: Iterator<Item = S>> Iterator for ProgressBarIter<T> type Item = S;impl<R: Read> Read for ProgressBarIter<R>impl<W: Write> Write for ProgressBarIter<W>
;
fn try_progress(self) -> Option<ProgressBarIter<Self>> { ... }
fn progress(self) -> ProgressBarIter<Self>ⓘNotable traits for ProgressBarIter<T>impl<S, T: Iterator<Item = S>> Iterator for ProgressBarIter<T> type Item = S;impl<R: Read> Read for ProgressBarIter<R>impl<W: Write> Write for ProgressBarIter<W>
where
Self: ExactSizeIterator,
{ ... }
fn progress_count(self, len: u64) -> ProgressBarIter<Self>ⓘNotable traits for ProgressBarIter<T>impl<S, T: Iterator<Item = S>> Iterator for ProgressBarIter<T> type Item = S;impl<R: Read> Read for ProgressBarIter<R>impl<W: Write> Write for ProgressBarIter<W>
{ ... }
}
Expand description
Wraps an iterator to display its progress.
Required Methods
fn progress_with(self, progress: ProgressBar) -> ProgressBarIter<Self>ⓘNotable traits for ProgressBarIter<T>impl<S, T: Iterator<Item = S>> Iterator for ProgressBarIter<T> type Item = S;impl<R: Read> Read for ProgressBarIter<R>impl<W: Write> Write for ProgressBarIter<W>
fn progress_with(self, progress: ProgressBar) -> ProgressBarIter<Self>ⓘNotable traits for ProgressBarIter<T>impl<S, T: Iterator<Item = S>> Iterator for ProgressBarIter<T> type Item = S;impl<R: Read> Read for ProgressBarIter<R>impl<W: Write> Write for ProgressBarIter<W>
Wrap an iterator with a custom progress bar.
Provided Methods
fn try_progress(self) -> Option<ProgressBarIter<Self>>
fn try_progress(self) -> Option<ProgressBarIter<Self>>
Wrap an iterator with default styling. Uses Iterator::size_hint
to get length.
Returns Some(..)
only if size_hint.1
is Some
. If you want to create a progress bar
even if size_hint.1
returns None
use progress_count
or progress_with
instead.
fn progress(self) -> ProgressBarIter<Self>ⓘNotable traits for ProgressBarIter<T>impl<S, T: Iterator<Item = S>> Iterator for ProgressBarIter<T> type Item = S;impl<R: Read> Read for ProgressBarIter<R>impl<W: Write> Write for ProgressBarIter<W>
where
Self: ExactSizeIterator,
fn progress(self) -> ProgressBarIter<Self>ⓘNotable traits for ProgressBarIter<T>impl<S, T: Iterator<Item = S>> Iterator for ProgressBarIter<T> type Item = S;impl<R: Read> Read for ProgressBarIter<R>impl<W: Write> Write for ProgressBarIter<W>
where
Self: ExactSizeIterator,
Wrap an iterator with default styling.
fn progress_count(self, len: u64) -> ProgressBarIter<Self>ⓘNotable traits for ProgressBarIter<T>impl<S, T: Iterator<Item = S>> Iterator for ProgressBarIter<T> type Item = S;impl<R: Read> Read for ProgressBarIter<R>impl<W: Write> Write for ProgressBarIter<W>
fn progress_count(self, len: u64) -> ProgressBarIter<Self>ⓘNotable traits for ProgressBarIter<T>impl<S, T: Iterator<Item = S>> Iterator for ProgressBarIter<T> type Item = S;impl<R: Read> Read for ProgressBarIter<R>impl<W: Write> Write for ProgressBarIter<W>
Wrap an iterator with an explicit element count.