Struct flatcontainer::FlatStack

pub struct FlatStack<R: Region> { /* private fields */ }

A container for indices into a region.

Implementations

impl<R: Region> FlatStack<R>

pub fn default_impl<T: Containerized<Region = R>>() -> Self

Default implementation based on the preference of type T.

pub fn with_capacity(capacity: usize) -> Self

Returns a flat stack that can absorb capacity indices without reallocation.

Prefer Self::merge_capacity over this function to also pre-size the regions.

pub fn merge_capacity<'a, I: Iterator<Item = &'a Self> + Clone + 'a>( stacks: I ) -> Self

where R: 'a,

Returns a flat stack that can absorb the contents of iter without reallocation.

pub fn copy(&mut self, item: impl CopyOnto<R>)

Appends the element to the back of the stack.

pub fn get(&self, offset: usize) -> R::ReadItem<'_>

Returns the element at the offset position.

pub fn len(&self) -> usize

Returns the number of indices in the stack.

pub fn is_empty(&self) -> bool

Returns true if the stack contains no elements.

pub fn capacity(&self) -> usize

Returns the total number of indices the stack can hold without reallocation.

pub fn reserve(&mut self, additional: usize)

Reserves space to hold additional indices.

pub fn clear(&mut self)

Remove all elements while possibly retaining allocations.

pub fn reserve_items<T>(&mut self, items: impl Iterator<Item = T> + Clone)

where T: ReserveItems<R>,

Reserve space for the items returned by the iterator.

pub fn reserve_regions<'a>( &mut self, regions: impl Iterator<Item = &'a R> + Clone )

where R: 'a,

Reserve space for the regions returned by the iterator.

pub fn iter(&self) -> Iter<'_, R>

Iterate the items in this stack.

pub fn heap_size<F: FnMut(usize, usize)>(&self, callback: F)

Heap size, size - capacity

Trait Implementations

impl<R: Region> Clone for FlatStack<R>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: Region> Debug for FlatStack<R>

where for<'a> R::ReadItem<'a>: Debug,

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

Formats the value using the given formatter.

impl<R: Region> Default for FlatStack<R>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, R> Deserialize<'de> for FlatStack<R>

where R: Serialize + for<'a> Deserialize<'a> + Region, R::Index: Serialize + for<'a> Deserialize<'a>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: CopyOnto<R>, R: Region> Extend<T> for FlatStack<R>

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

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<R: Region, T: CopyOnto<R>> FromIterator<T> for FlatStack<R>

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

Creates a value from an iterator.

impl<'a, R: Region> IntoIterator for &'a FlatStack<R>

type Item = <R as Region>::ReadItem<'a>

The type of the elements being iterated over.

type IntoIter = Iter<'a, R>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<R> Serialize for FlatStack<R>

where R: Serialize + for<'a> Deserialize<'a> + Region, R::Index: Serialize + for<'a> Deserialize<'a>,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.