Struct timely_container::flatcontainer::FlatStack

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

A container for indices into a region.

Implementations

impl<R> FlatStack<R>

where R: Region,

pub fn default_impl<T>() -> FlatStack<R>

where T: RegionPreference<Region = R>,

Default implementation based on the preference of type T.

pub fn with_capacity(capacity: usize) -> FlatStack<R>

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>(stacks: I) -> FlatStack<R>

where I: Iterator<Item = &'a FlatStack<R>> + Clone + 'a, R: 'a,

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

pub fn copy<T>(&mut self, item: T)

where R: Push<T>,

Appends the element to the back of the stack.

pub fn get(&self, offset: usize) -> <R as Region>::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 R: ReserveItems<T>,

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>(&self, callback: F)

where F: FnMut(usize, usize),

Heap size, size - capacity

Trait Implementations

impl<R> Clone for FlatStack<R>

where R: Region + Clone,

fn clone(&self) -> FlatStack<R>

Returns a copy of the value.

fn clone_from(&mut self, source: &FlatStack<R>)

Performs copy-assignment from source.

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

type ItemRef<'a> = <R as Region>::ReadItem<'a> where Self: 'a

The type of elements when reading non-destructively from the container.

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

The type of elements when draining the container.

fn len(&self) -> usize

The number of elements in this container

fn clear(&mut self)

Remove all contents from self while retaining allocated memory. After calling clear, is_empty must return true and len 0.

type Iter<'a> = <&'a FlatStack<R> as IntoIterator>::IntoIter where Self: 'a

Iterator type when reading from the container.

fn iter(&self) -> Self::Iter<'_>

Returns an iterator that reads the contents of this container.

type DrainIter<'a> = <FlatStack<R> as Container>::Iter<'a> where Self: 'a

Iterator type when draining the container.

fn drain(&mut self) -> Self::DrainIter<'_>

Returns an iterator that drains the contents of this container. Drain leaves the container in an undefined state.

fn push<T>(&mut self, item: T)

where Self: PushInto<T>,

Push item into self

fn is_empty(&self) -> bool

Determine if the container contains any elements, corresponding to len() == 0.

impl<R> Debug for FlatStack<R>

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

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

Formats the value using the given formatter.

impl<R> Default for FlatStack<R>

where R: Region,

fn default() -> FlatStack<R>

Returns the “default value” for a type.

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

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<FlatStack<R>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, R> Extend<T> for FlatStack<R>

where R: Region + Push<T>,

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = 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<R, T> FromIterator<T> for FlatStack<R>

where R: Region + Push<T>,

fn from_iter<I>(iter: I) -> FlatStack<R>

where I: IntoIterator<Item = T>,

Creates a value from an iterator.

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

where R: Region,

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) -> <&'a FlatStack<R> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<R: Region + Push<T>, T> PushInto<T> for FlatStack<R>

fn push_into(&mut self, item: T)

Push item into self.

impl<R> Serialize for FlatStack<R>

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

fn at_capacity(&self) -> bool

Indicates that the container is “full” and should be shipped.

fn ensure_capacity(&mut self, stash: &mut Option<Self>)

Restores self to its desired capacity, if it has one.