Struct ArrayStorage 

pub struct ArrayStorage<const CAP: usize, IT: Iterator> { /* private fields */ }

Fixed-capacity array-based storage for MergeIter

Implementations

impl<IT: Iterator> ArrayStorage<0, IT>

pub const fn with_capacity<const CAP: usize>() -> ArrayStorage<CAP, IT>

Create ArrayStorage with given capacity and inferred iterator type

impl<const CAP: usize, IT: Iterator> ArrayStorage<CAP, IT>

pub const fn new() -> Self

Create a new ArrayStorage

Example

Building a merge iterator from an ArrayStorage.

use core::{iter, pin::pin};

use iter_merge::ArrayStorage;

let mut storage: ArrayStorage<5, _> = ArrayStorage::new();
storage.push(iter::once(2));
storage.push(iter::once(1));
let storage = pin!(storage);
let it = storage.build();
assert!(it.eq([1, 2]));

pub fn from_arr<T: IntoIterator<IntoIter = IT>>(iters: [T; CAP]) -> Self

Creates a new ArrayStorage with the same CAP as the provided array.

Example

Building a merge iterator from an ArrayStorage.

use core::{iter, pin::pin};

use iter_merge::ArrayStorage;
let storage = ArrayStorage::from_arr([[1, 3], [2, 4]]);
assert_eq!(storage.capacity(), 2)

pub fn len(&self) -> usize

Returns the number of non-empty iterators stored in ArrayStorage

pub const fn capacity(&self) -> usize

Returns the (fixed) capacity of ArrayStorage

pub fn is_empty(&self) -> bool

Returns true if this ArrayStorage is empty

pub fn push<Iter>(&mut self, iter: Iter)

where Iter: IntoIterator<IntoIter = IT>,

Appends an element to the back of a collection.

Panics

Panics if the collection is full.

pub fn try_push<Iter>( &mut self, iter: Iter, ) -> Result<(), ArrayCapacityOverflow>

where Iter: IntoIterator<IntoIter = IT>,

Tries to append an element to the back of a collection.

Errors

Returns error if the ArrayStorage is full

pub fn into_builder( self: Pin<&mut Self>, ) -> DefaultBuilder<InternalArrayStorage<'_, IT>>

Constructs a [Builder] from this storage.

Note: the storage cannot move for MergeIter to work, thus you need to call this method on a pinned mutable reference.

Example:

use core::{iter, pin::pin};

use iter_merge::ArrayStorage;
let mut storage = ArrayStorage::<5, _>::new();
storage.push(iter::once(1));
let storage = pin!(storage);
let _builder = storage.into_builder();

pub fn build( self: Pin<&mut Self>, ) -> DefaultMergeIter<InternalArrayStorage<'_, IT>>

where IT::Item: Ord,

Constructs a [MergeIter] from this storage with default parameters.

Equivalent to calling Self::into_builder().build()

Trait Implementations

impl<const CAP: usize, IT: Iterator> Debug for ArrayStorage<CAP, IT>

where PeekIter<IT>: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<const CAP: usize, IT: Iterator> Default for ArrayStorage<CAP, IT>

fn default() -> Self

Returns the “default value” for a type.

impl<const CAP: usize, IT: Iterator> Drop for ArrayStorage<CAP, IT>

fn drop(&mut self)

Executes the destructor for this type.

impl<const CAP: usize, IT: Iterator, A> Extend<A> for ArrayStorage<CAP, IT>

where A: IntoIterator<IntoIter = IT>,

fn extend<T: IntoIterator<Item = A>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<const CAP: usize, IT, Item> FromIterator<Item> for ArrayStorage<CAP, IT>

where IT: Iterator, Item: IntoIterator<IntoIter = IT>,

fn from_iter<T: IntoIterator<Item = Item>>(iter: T) -> Self

Creates a value from an iterator.