pub struct StepBy<I: IndexedParallelIterator> {
base: I,
step: usize,
}
Expand description
StepBy
is an iterator that skips n
elements between each yield, where n
is the given step.
This struct is created by the step_by()
method on IndexedParallelIterator
Fields§
§base: I
§step: usize
Implementations§
Trait Implementations§
source§impl<I> IndexedParallelIterator for StepBy<I>where
I: IndexedParallelIterator,
impl<I> IndexedParallelIterator for StepBy<I>where
I: IndexedParallelIterator,
source§fn drive<C: Consumer<Self::Item>>(self, consumer: C) -> C::Result
fn drive<C: Consumer<Self::Item>>(self, consumer: C) -> C::Result
Internal method used to define the behavior of this parallel
iterator. You should not need to call this directly. Read more
source§fn len(&self) -> usize
fn len(&self) -> usize
Produces an exact count of how many items this iterator will
produce, presuming no panic occurs. Read more
source§fn with_producer<CB>(self, callback: CB) -> CB::Outputwhere
CB: ProducerCallback<Self::Item>,
fn with_producer<CB>(self, callback: CB) -> CB::Outputwhere
CB: ProducerCallback<Self::Item>,
Internal method used to define the behavior of this parallel
iterator. You should not need to call this directly. Read more
source§fn by_exponential_blocks(self) -> ExponentialBlocks<Self>
fn by_exponential_blocks(self) -> ExponentialBlocks<Self>
Divides an iterator into sequential blocks of exponentially-increasing size. Read more
source§fn by_uniform_blocks(self, block_size: usize) -> UniformBlocks<Self>
fn by_uniform_blocks(self, block_size: usize) -> UniformBlocks<Self>
Divides an iterator into sequential blocks of the given size. Read more
source§fn collect_into_vec(self, target: &mut Vec<Self::Item>)
fn collect_into_vec(self, target: &mut Vec<Self::Item>)
Collects the results of the iterator into the specified
vector. The vector is always cleared before execution
begins. If possible, reusing the vector across calls can lead
to better performance since it reuses the same backing buffer. Read more
source§fn unzip_into_vecs<A, B>(self, left: &mut Vec<A>, right: &mut Vec<B>)
fn unzip_into_vecs<A, B>(self, left: &mut Vec<A>, right: &mut Vec<B>)
Unzips the results of the iterator into the specified
vectors. The vectors are always cleared before execution
begins. If possible, reusing the vectors across calls can lead
to better performance since they reuse the same backing buffer. Read more
source§fn zip<Z>(self, zip_op: Z) -> Zip<Self, Z::Iter>
fn zip<Z>(self, zip_op: Z) -> Zip<Self, Z::Iter>
Iterates over tuples
(A, B)
, where the items A
are from
this iterator and B
are from the iterator given as argument.
Like the zip
method on ordinary iterators, if the two
iterators are of unequal length, you only get the items they
have in common. Read moresource§fn zip_eq<Z>(self, zip_op: Z) -> ZipEq<Self, Z::Iter>
fn zip_eq<Z>(self, zip_op: Z) -> ZipEq<Self, Z::Iter>
The same as
Zip
, but requires that both iterators have the same length. Read moresource§fn interleave<I>(self, other: I) -> Interleave<Self, I::Iter>where
I: IntoParallelIterator<Item = Self::Item>,
I::Iter: IndexedParallelIterator<Item = Self::Item>,
fn interleave<I>(self, other: I) -> Interleave<Self, I::Iter>where
I: IntoParallelIterator<Item = Self::Item>,
I::Iter: IndexedParallelIterator<Item = Self::Item>,
Interleaves elements of this iterator and the other given
iterator. Alternately yields elements from this iterator and
the given iterator, until both are exhausted. If one iterator
is exhausted before the other, the last elements are provided
from the other. Read more
source§fn interleave_shortest<I>(self, other: I) -> InterleaveShortest<Self, I::Iter>where
I: IntoParallelIterator<Item = Self::Item>,
I::Iter: IndexedParallelIterator<Item = Self::Item>,
fn interleave_shortest<I>(self, other: I) -> InterleaveShortest<Self, I::Iter>where
I: IntoParallelIterator<Item = Self::Item>,
I::Iter: IndexedParallelIterator<Item = Self::Item>,
Interleaves elements of this iterator and the other given
iterator, until one is exhausted. Read more
source§fn chunks(self, chunk_size: usize) -> Chunks<Self>
fn chunks(self, chunk_size: usize) -> Chunks<Self>
Splits an iterator up into fixed-size chunks. Read more
source§fn fold_chunks<T, ID, F>(
self,
chunk_size: usize,
identity: ID,
fold_op: F,
) -> FoldChunks<Self, ID, F>
fn fold_chunks<T, ID, F>( self, chunk_size: usize, identity: ID, fold_op: F, ) -> FoldChunks<Self, ID, F>
source§fn fold_chunks_with<T, F>(
self,
chunk_size: usize,
init: T,
fold_op: F,
) -> FoldChunksWith<Self, T, F>
fn fold_chunks_with<T, F>( self, chunk_size: usize, init: T, fold_op: F, ) -> FoldChunksWith<Self, T, F>
source§fn partial_cmp<I>(self, other: I) -> Option<Ordering>
fn partial_cmp<I>(self, other: I) -> Option<Ordering>
Lexicographically compares the elements of this
ParallelIterator
with those of
another. Read moresource§fn eq<I>(self, other: I) -> bool
fn eq<I>(self, other: I) -> bool
Determines if the elements of this
ParallelIterator
are equal to those of anothersource§fn ne<I>(self, other: I) -> bool
fn ne<I>(self, other: I) -> bool
Determines if the elements of this
ParallelIterator
are unequal to those of anothersource§fn lt<I>(self, other: I) -> bool
fn lt<I>(self, other: I) -> bool
Determines if the elements of this
ParallelIterator
are lexicographically less than those of another.source§fn le<I>(self, other: I) -> bool
fn le<I>(self, other: I) -> bool
Determines if the elements of this
ParallelIterator
are less or equal to those of another.source§fn gt<I>(self, other: I) -> bool
fn gt<I>(self, other: I) -> bool
Determines if the elements of this
ParallelIterator
are lexicographically greater than those of another.source§fn ge<I>(self, other: I) -> bool
fn ge<I>(self, other: I) -> bool
Determines if the elements of this
ParallelIterator
are less or equal to those of another.source§fn step_by(self, step: usize) -> StepBy<Self>
fn step_by(self, step: usize) -> StepBy<Self>
Creates an iterator that steps by the given amount Read more
source§fn skip(self, n: usize) -> Skip<Self>
fn skip(self, n: usize) -> Skip<Self>
Creates an iterator that skips the first
n
elements. Read moresource§fn take(self, n: usize) -> Take<Self>
fn take(self, n: usize) -> Take<Self>
Creates an iterator that yields the first
n
elements. Read moresource§fn position_any<P>(self, predicate: P) -> Option<usize>
fn position_any<P>(self, predicate: P) -> Option<usize>
Searches for some item in the parallel iterator that
matches the given predicate, and returns its index. Like
ParallelIterator::find_any
, the parallel search will not
necessarily find the first match, and once a match is
found we’ll attempt to stop processing any more. Read moresource§fn position_first<P>(self, predicate: P) -> Option<usize>
fn position_first<P>(self, predicate: P) -> Option<usize>
Searches for the sequentially first item in the parallel iterator
that matches the given predicate, and returns its index. Read more
source§fn position_last<P>(self, predicate: P) -> Option<usize>
fn position_last<P>(self, predicate: P) -> Option<usize>
Searches for the sequentially last item in the parallel iterator
that matches the given predicate, and returns its index. Read more
source§fn positions<P>(self, predicate: P) -> Positions<Self, P>
fn positions<P>(self, predicate: P) -> Positions<Self, P>
Searches for items in the parallel iterator that match the given
predicate, and returns their indices. Read more
source§fn rev(self) -> Rev<Self>
fn rev(self) -> Rev<Self>
Produces a new iterator with the elements of this iterator in
reverse order. Read more
source§fn with_min_len(self, min: usize) -> MinLen<Self>
fn with_min_len(self, min: usize) -> MinLen<Self>
Sets the minimum length of iterators desired to process in each
rayon job. Rayon will not split any smaller than this length, but
of course an iterator could already be smaller to begin with. Read more
source§fn with_max_len(self, max: usize) -> MaxLen<Self>
fn with_max_len(self, max: usize) -> MaxLen<Self>
Sets the maximum length of iterators desired to process in each
rayon job. Rayon will try to split at least below this length,
unless that would put it below the length from
with_min_len()
.
For example, given min=10 and max=15, a length of 16 will not be
split any further. Read moresource§impl<I> ParallelIterator for StepBy<I>where
I: IndexedParallelIterator,
impl<I> ParallelIterator for StepBy<I>where
I: IndexedParallelIterator,
§type Item = <I as ParallelIterator>::Item
type Item = <I as ParallelIterator>::Item
The type of item that this parallel iterator produces.
For example, if you use the
for_each
method, this is the type of
item that your closure will be invoked with.source§fn drive_unindexed<C>(self, consumer: C) -> C::Resultwhere
C: UnindexedConsumer<Self::Item>,
fn drive_unindexed<C>(self, consumer: C) -> C::Resultwhere
C: UnindexedConsumer<Self::Item>,
Internal method used to define the behavior of this parallel
iterator. You should not need to call this directly. Read more
source§fn opt_len(&self) -> Option<usize>
fn opt_len(&self) -> Option<usize>
Internal method used to define the behavior of this parallel
iterator. You should not need to call this directly. Read more
source§fn for_each<OP>(self, op: OP)
fn for_each<OP>(self, op: OP)
Executes
OP
on each item produced by the iterator, in parallel. Read moresource§fn for_each_with<OP, T>(self, init: T, op: OP)
fn for_each_with<OP, T>(self, init: T, op: OP)
source§fn for_each_init<OP, INIT, T>(self, init: INIT, op: OP)
fn for_each_init<OP, INIT, T>(self, init: INIT, op: OP)
Executes
OP
on a value returned by init
with each item produced by
the iterator, in parallel. Read moresource§fn try_for_each<OP, R>(self, op: OP) -> R
fn try_for_each<OP, R>(self, op: OP) -> R
Executes a fallible
OP
on each item produced by the iterator, in parallel. Read moresource§fn try_for_each_with<OP, T, R>(self, init: T, op: OP) -> R
fn try_for_each_with<OP, T, R>(self, init: T, op: OP) -> R
Executes a fallible
OP
on the given init
value with each item
produced by the iterator, in parallel. Read moresource§fn try_for_each_init<OP, INIT, T, R>(self, init: INIT, op: OP) -> R
fn try_for_each_init<OP, INIT, T, R>(self, init: INIT, op: OP) -> R
Executes a fallible
OP
on a value returned by init
with each item
produced by the iterator, in parallel. Read moresource§fn map<F, R>(self, map_op: F) -> Map<Self, F>
fn map<F, R>(self, map_op: F) -> Map<Self, F>
Applies
map_op
to each item of this iterator, producing a new
iterator with the results. Read moresource§fn map_with<F, T, R>(self, init: T, map_op: F) -> MapWith<Self, T, F>
fn map_with<F, T, R>(self, init: T, map_op: F) -> MapWith<Self, T, F>
Applies
map_op
to the given init
value with each item of this
iterator, producing a new iterator with the results. Read moresource§fn map_init<F, INIT, T, R>(
self,
init: INIT,
map_op: F,
) -> MapInit<Self, INIT, F>
fn map_init<F, INIT, T, R>( self, init: INIT, map_op: F, ) -> MapInit<Self, INIT, F>
Applies
map_op
to a value returned by init
with each item of this
iterator, producing a new iterator with the results. Read moresource§fn inspect<OP>(self, inspect_op: OP) -> Inspect<Self, OP>
fn inspect<OP>(self, inspect_op: OP) -> Inspect<Self, OP>
Applies
inspect_op
to a reference to each item of this iterator,
producing a new iterator passing through the original items. This is
often useful for debugging to see what’s happening in iterator stages. Read moresource§fn update<F>(self, update_op: F) -> Update<Self, F>
fn update<F>(self, update_op: F) -> Update<Self, F>
Mutates each item of this iterator before yielding it. Read more
source§fn filter<P>(self, filter_op: P) -> Filter<Self, P>
fn filter<P>(self, filter_op: P) -> Filter<Self, P>
Applies
filter_op
to each item of this iterator, producing a new
iterator with only the items that gave true
results. Read moresource§fn filter_map<P, R>(self, filter_op: P) -> FilterMap<Self, P>
fn filter_map<P, R>(self, filter_op: P) -> FilterMap<Self, P>
Applies
filter_op
to each item of this iterator to get an Option
,
producing a new iterator with only the items from Some
results. Read moresource§fn flat_map<F, PI>(self, map_op: F) -> FlatMap<Self, F>
fn flat_map<F, PI>(self, map_op: F) -> FlatMap<Self, F>
Applies
map_op
to each item of this iterator to get nested parallel iterators,
producing a new parallel iterator that flattens these back into one. Read moresource§fn flat_map_iter<F, SI>(self, map_op: F) -> FlatMapIter<Self, F>
fn flat_map_iter<F, SI>(self, map_op: F) -> FlatMapIter<Self, F>
Applies
map_op
to each item of this iterator to get nested serial iterators,
producing a new parallel iterator that flattens these back into one. Read moresource§fn reduce<OP, ID>(self, identity: ID, op: OP) -> Self::Item
fn reduce<OP, ID>(self, identity: ID, op: OP) -> Self::Item
Reduces the items in the iterator into one item using
op
.
The argument identity
should be a closure that can produce
“identity” value which may be inserted into the sequence as
needed to create opportunities for parallel execution. So, for
example, if you are doing a summation, then identity()
ought
to produce something that represents the zero for your type
(but consider just calling sum()
in that case). Read moresource§fn reduce_with<OP>(self, op: OP) -> Option<Self::Item>
fn reduce_with<OP>(self, op: OP) -> Option<Self::Item>
Reduces the items in the iterator into one item using
op
.
If the iterator is empty, None
is returned; otherwise,
Some
is returned. Read moresource§fn fold<T, ID, F>(self, identity: ID, fold_op: F) -> Fold<Self, ID, F>
fn fold<T, ID, F>(self, identity: ID, fold_op: F) -> Fold<Self, ID, F>
Parallel fold is similar to sequential fold except that the
sequence of items may be subdivided before it is
folded. Consider a list of numbers like
22 3 77 89 46
. If
you used sequential fold to add them (fold(0, |a,b| a+b)
,
you would wind up first adding 0 + 22, then 22 + 3, then 25 +
77, and so forth. The parallel fold works similarly except
that it first breaks up your list into sublists, and hence
instead of yielding up a single sum at the end, it yields up
multiple sums. The number of results is nondeterministic, as
is the point where the breaks occur. Read moresource§fn fold_with<F, T>(self, init: T, fold_op: F) -> FoldWith<Self, T, F>
fn fold_with<F, T>(self, init: T, fold_op: F) -> FoldWith<Self, T, F>
Applies
fold_op
to the given init
value with each item of this
iterator, finally producing the value for further use. Read moresource§fn try_fold<T, R, ID, F>(
self,
identity: ID,
fold_op: F,
) -> TryFold<Self, R, ID, F>
fn try_fold<T, R, ID, F>( self, identity: ID, fold_op: F, ) -> TryFold<Self, R, ID, F>
Performs a fallible parallel fold. Read more
source§fn try_fold_with<F, T, R>(self, init: T, fold_op: F) -> TryFoldWith<Self, R, F>
fn try_fold_with<F, T, R>(self, init: T, fold_op: F) -> TryFoldWith<Self, R, F>
Performs a fallible parallel fold with a cloneable
init
value. Read moresource§fn min_by<F>(self, f: F) -> Option<Self::Item>
fn min_by<F>(self, f: F) -> Option<Self::Item>
Computes the minimum of all the items in the iterator with respect to
the given comparison function. If the iterator is empty,
None
is
returned; otherwise, Some(min)
is returned. Read moresource§fn min_by_key<K, F>(self, f: F) -> Option<Self::Item>
fn min_by_key<K, F>(self, f: F) -> Option<Self::Item>
Computes the item that yields the minimum value for the given
function. If the iterator is empty,
None
is returned;
otherwise, Some(item)
is returned. Read moresource§fn max_by<F>(self, f: F) -> Option<Self::Item>
fn max_by<F>(self, f: F) -> Option<Self::Item>
Computes the maximum of all the items in the iterator with respect to
the given comparison function. If the iterator is empty,
None
is
returned; otherwise, Some(max)
is returned. Read moresource§fn max_by_key<K, F>(self, f: F) -> Option<Self::Item>
fn max_by_key<K, F>(self, f: F) -> Option<Self::Item>
Computes the item that yields the maximum value for the given
function. If the iterator is empty,
None
is returned;
otherwise, Some(item)
is returned. Read moresource§fn chain<C>(self, chain: C) -> Chain<Self, C::Iter>where
C: IntoParallelIterator<Item = Self::Item>,
fn chain<C>(self, chain: C) -> Chain<Self, C::Iter>where
C: IntoParallelIterator<Item = Self::Item>,
Takes two iterators and creates a new iterator over both. Read more
source§fn find_any<P>(self, predicate: P) -> Option<Self::Item>
fn find_any<P>(self, predicate: P) -> Option<Self::Item>
Searches for some item in the parallel iterator that
matches the given predicate and returns it. This operation
is similar to
find
on sequential iterators but
the item returned may not be the first one in the parallel
sequence which matches, since we search the entire sequence in parallel. Read moresource§fn find_first<P>(self, predicate: P) -> Option<Self::Item>
fn find_first<P>(self, predicate: P) -> Option<Self::Item>
Searches for the sequentially first item in the parallel iterator
that matches the given predicate and returns it. Read more
source§fn find_last<P>(self, predicate: P) -> Option<Self::Item>
fn find_last<P>(self, predicate: P) -> Option<Self::Item>
Searches for the sequentially last item in the parallel iterator
that matches the given predicate and returns it. Read more
source§fn find_map_any<P, R>(self, predicate: P) -> Option<R>
fn find_map_any<P, R>(self, predicate: P) -> Option<R>
Applies the given predicate to the items in the parallel iterator
and returns any non-None result of the map operation. Read more
source§fn find_map_first<P, R>(self, predicate: P) -> Option<R>
fn find_map_first<P, R>(self, predicate: P) -> Option<R>
Applies the given predicate to the items in the parallel iterator and
returns the sequentially first non-None result of the map operation. Read more
source§fn find_map_last<P, R>(self, predicate: P) -> Option<R>
fn find_map_last<P, R>(self, predicate: P) -> Option<R>
Applies the given predicate to the items in the parallel iterator and
returns the sequentially last non-None result of the map operation. Read more
source§fn any<P>(self, predicate: P) -> bool
fn any<P>(self, predicate: P) -> bool
Searches for some item in the parallel iterator that
matches the given predicate, and if so returns true. Once
a match is found, we’ll attempt to stop process the rest
of the items. Proving that there’s no match, returning false,
does require visiting every item. Read more
source§fn all<P>(self, predicate: P) -> bool
fn all<P>(self, predicate: P) -> bool
Tests that every item in the parallel iterator matches the given
predicate, and if so returns true. If a counter-example is found,
we’ll attempt to stop processing more items, then return false. Read more
source§fn while_some<T>(self) -> WhileSome<Self>
fn while_some<T>(self) -> WhileSome<Self>
Creates an iterator over the
Some
items of this iterator, halting
as soon as any None
is found. Read moresource§fn panic_fuse(self) -> PanicFuse<Self>
fn panic_fuse(self) -> PanicFuse<Self>
Wraps an iterator with a fuse in case of panics, to halt all threads
as soon as possible. Read more
source§fn collect<C>(self) -> Cwhere
C: FromParallelIterator<Self::Item>,
fn collect<C>(self) -> Cwhere
C: FromParallelIterator<Self::Item>,
Creates a fresh collection containing all the elements produced
by this parallel iterator. Read more
source§fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)where
Self: ParallelIterator<Item = (A, B)>,
FromA: Default + Send + ParallelExtend<A>,
FromB: Default + Send + ParallelExtend<B>,
A: Send,
B: Send,
fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)where
Self: ParallelIterator<Item = (A, B)>,
FromA: Default + Send + ParallelExtend<A>,
FromB: Default + Send + ParallelExtend<B>,
A: Send,
B: Send,
Unzips the items of a parallel iterator into a pair of arbitrary
ParallelExtend
containers. Read moresource§fn partition<A, B, P>(self, predicate: P) -> (A, B)
fn partition<A, B, P>(self, predicate: P) -> (A, B)
Partitions the items of a parallel iterator into a pair of arbitrary
ParallelExtend
containers. Items for which the predicate
returns
true go into the first container, and the rest go into the second. Read moresource§fn partition_map<A, B, P, L, R>(self, predicate: P) -> (A, B)
fn partition_map<A, B, P, L, R>(self, predicate: P) -> (A, B)
Partitions and maps the items of a parallel iterator into a pair of
arbitrary
ParallelExtend
containers. Either::Left
items go into
the first container, and Either::Right
items go into the second. Read moresource§fn take_any(self, n: usize) -> TakeAny<Self>
fn take_any(self, n: usize) -> TakeAny<Self>
Creates an iterator that yields
n
elements from anywhere in the original iterator. Read moresource§fn skip_any(self, n: usize) -> SkipAny<Self>
fn skip_any(self, n: usize) -> SkipAny<Self>
Creates an iterator that skips
n
elements from anywhere in the original iterator. Read moresource§fn take_any_while<P>(self, predicate: P) -> TakeAnyWhile<Self, P>
fn take_any_while<P>(self, predicate: P) -> TakeAnyWhile<Self, P>
Creates an iterator that takes elements from anywhere in the original iterator
until the given
predicate
returns false
. Read moresource§fn skip_any_while<P>(self, predicate: P) -> SkipAnyWhile<Self, P>
fn skip_any_while<P>(self, predicate: P) -> SkipAnyWhile<Self, P>
Creates an iterator that skips elements from anywhere in the original iterator
until the given
predicate
returns false
. Read moresource§fn collect_vec_list(self) -> LinkedList<Vec<Self::Item>>
fn collect_vec_list(self) -> LinkedList<Vec<Self::Item>>
Collects this iterator into a linked list of vectors. Read more
Auto Trait Implementations§
impl<I> Freeze for StepBy<I>where
I: Freeze,
impl<I> RefUnwindSafe for StepBy<I>where
I: RefUnwindSafe,
impl<I> Send for StepBy<I>
impl<I> Sync for StepBy<I>where
I: Sync,
impl<I> Unpin for StepBy<I>where
I: Unpin,
impl<I> UnwindSafe for StepBy<I>where
I: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> IntoParallelIterator for Twhere
T: ParallelIterator,
impl<T> IntoParallelIterator for Twhere
T: ParallelIterator,
§type Item = <T as ParallelIterator>::Item
type Item = <T as ParallelIterator>::Item
The type of item that the parallel iterator will produce.
source§fn into_par_iter(self) -> T
fn into_par_iter(self) -> T
Converts
self
into a parallel iterator. Read more