Trait InPlaceIterable

#[doc(hidden)] pub unsafe trait InPlaceIterable {
    const EXPAND_BY: Option<NonZero<usize>>;
    const MERGE_BY: Option<NonZero<usize>>;
}

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

An iterator that when yielding an item will have taken at least one element from its underlying SourceIter.

Calling any method that advances the iterator, e.g. next() or try_fold(), guarantees that for each step at least one value of the iterator’s underlying source has been moved out and the result of the iterator chain could be inserted in its place, assuming structural constraints of the source allow such an insertion. In other words this trait indicates that an iterator pipeline can be collected in place.

The primary use of this trait is in-place iteration. Refer to the vec::in_place_collect module documentation for more information.

Required Associated Constants

const EXPAND_BY: Option<NonZero<usize>>

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

The product of one-to-many item expansions that happen throughout the iterator pipeline. E.g. [[u8; 4]; 4].iter().flatten().flatten() would have a EXPAND_BY of 16. This is an upper bound, i.e. the transformations will produce at most this many items per input. It’s meant for layout calculations.

const MERGE_BY: Option<NonZero<usize>>

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

The product of many-to-one item reductions that happen throughout the iterator pipeline. E.g. u8.iter().array_chunks::<4>().array_chunks::<4>() would have a MERGE_BY of 16. This is a lower bound, i.e. the transformations will consume at least this many items per output.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<A, B> InPlaceIterable for Zip<A, B>

where A: InPlaceIterable,

const EXPAND_BY: Option<NonZero<usize>> = A::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>> = A::MERGE_BY

impl<I> InPlaceIterable for Cloned<I>

where I: InPlaceIterable,

const EXPAND_BY: Option<NonZero<usize>> = I::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>> = I::MERGE_BY

impl<I> InPlaceIterable for Copied<I>

where I: InPlaceIterable,

const EXPAND_BY: Option<NonZero<usize>> = I::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>> = I::MERGE_BY

impl<I> InPlaceIterable for Enumerate<I>

where I: InPlaceIterable,

const EXPAND_BY: Option<NonZero<usize>> = I::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>> = I::MERGE_BY

impl<I> InPlaceIterable for Skip<I>

where I: InPlaceIterable,

const EXPAND_BY: Option<NonZero<usize>> = I::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>> = I::MERGE_BY

impl<I> InPlaceIterable for Take<I>

where I: InPlaceIterable,

const EXPAND_BY: Option<NonZero<usize>> = I::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>> = I::MERGE_BY

impl<I, F> InPlaceIterable for FilterMap<I, F>

where I: InPlaceIterable,

const EXPAND_BY: Option<NonZero<usize>> = I::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>> = I::MERGE_BY

impl<I, F> InPlaceIterable for Inspect<I, F>

where I: InPlaceIterable,

const EXPAND_BY: Option<NonZero<usize>> = I::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>> = I::MERGE_BY

impl<I, F> InPlaceIterable for Map<I, F>

where I: InPlaceIterable,

const EXPAND_BY: Option<NonZero<usize>> = I::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>> = I::MERGE_BY

impl<I, F> InPlaceIterable for SkipWhile<I, F>

where I: InPlaceIterable,

const EXPAND_BY: Option<NonZero<usize>> = I::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>> = I::MERGE_BY

impl<I, F> InPlaceIterable for TakeWhile<I, F>

where I: InPlaceIterable,

const EXPAND_BY: Option<NonZero<usize>> = I::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>> = I::MERGE_BY

impl<I, P> InPlaceIterable for Filter<I, P>

where I: InPlaceIterable,

const EXPAND_BY: Option<NonZero<usize>> = I::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>> = I::MERGE_BY

impl<I, P> InPlaceIterable for MapWhile<I, P>

where I: InPlaceIterable,

const EXPAND_BY: Option<NonZero<usize>> = I::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>> = I::MERGE_BY

impl<I, const N: usize> InPlaceIterable for ArrayChunks<I, N>

where I: InPlaceIterable + Iterator,

const EXPAND_BY: Option<NonZero<usize>> = I::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>>

impl<St, F, I> InPlaceIterable for Scan<I, St, F>

where I: InPlaceIterable,

const EXPAND_BY: Option<NonZero<usize>> = I::EXPAND_BY

const MERGE_BY: Option<NonZero<usize>> = I::MERGE_BY