Struct mz_timely_util::containers::stack::ChunkedStack

pub struct ChunkedStack<T: Columnation> {
    local: Vec<Array<T>>,
    inner: T::InnerRegion,
    length: usize,
}

An append-only vector that store records as columns.

This container maintains elements that might conventionally own memory allocations, but instead the pointers to those allocations reference larger regions of memory shared with multiple instances of the type. Elements can be retrieved as references, and care is taken when this type is dropped to ensure that the correct memory is returned (rather than the incorrect memory, from running the elements Drop implementations).

Fields

local: Vec<Array<T>>

inner: T::InnerRegion

length: usize

Implementations

impl<T: Columnation> ChunkedStack<T>

const CHUNK: usize = 65_536usize

The capacity of each individual chunk, in number of elements. Should be a power of two.

pub fn with_capacity(capacity: usize) -> Self

Construct a ChunkedStack, reserving space for capacity elements

Note that the associated region is not initialized to a specific capacity because we can’t generally know how much space would be required.

pub fn capacity(&self) -> usize

The capacity of the local array.

pub fn reserve_items<'a, I>(&'a mut self, items: I)

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

Ensures Self can absorb items without further allocations.

The argument items may be cloned and iterated multiple times. Please be careful if it contains side effects.

pub fn reserve_regions<'a, I>(&mut self, regions: I)

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

Ensures Self can absorb regions without further allocations.

The argument regions may be cloned and iterated multiple times. Please be careful if it contains side effects.

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

Copies an element in to the region.

The element can be read by indexing

fn push(&mut self, item: T)

Internal helper to push a copied item onto the local storage. The item must be allocated in the region, because it will not be dropped.

pub fn heap_size(&self, callback: impl FnMut(usize, usize))

Estimate the memory capacity in bytes.

pub fn range(&self, r: impl RangeBounds<usize> + Debug) -> Iter<'_, T>

Iterate over a range of elements. Panics if the range mentions non-existent elements, i.e., its end is past the last element of this container.

fn index(&self, index: usize) -> &T

Lookup a specific element.

pub fn len(&self) -> usize

The number of elements we store.

pub fn is_empty(&self) -> bool

Test if this container is empty.

pub fn clear(&mut self)

Empties the collection.

Trait Implementations

impl<T: Ord + Columnation + ToOwned<Owned = T> + 'static> BatchContainer for ChunkedStack<T>

type Owned = T

An owned instance of Self::ReadItem<'_>.

type ReadItem<'a> = &'a <ChunkedStack<T> as BatchContainer>::Owned

The type that can be read back out of the container.

fn with_capacity(size: usize) -> Self

Creates a new container with sufficient capacity.

fn merge_capacity(cont1: &Self, cont2: &Self) -> Self

Creates a new container with sufficient capacity.

fn reborrow<'b, 'a: 'b>(item: Self::ReadItem<'a>) -> Self::ReadItem<'b>

Converts a read item into one with a narrower lifetime.

fn index(&self, index: usize) -> Self::ReadItem<'_>

Reference to the element at this position.

fn len(&self) -> usize

Number of contained elements

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

where Self: PushInto<D>,

Push an item into this container

fn last(&self) -> Option<Self::ReadItem<'_>>

Returns the last item if the container is non-empty.

fn is_empty(&self) -> bool

Indicates if the length is zero.

fn advance<F>(&self, start: usize, end: usize, function: F) -> usize

where F: for<'a> Fn(Self::ReadItem<'a>) -> bool,

Reports the number of elements satisfying the predicate.

impl<T: Columnation> Clone for ChunkedStack<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Columnation + 'static> Container for ChunkedStack<T>

type ItemRef<'a> = &'a T where Self: 'a

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

type Item<'a> = &'a T where Self: 'a

The type of elements when draining the container.

fn len(&self) -> usize

The number of elements in this container

fn is_empty(&self) -> bool

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

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> = Iter<'a, T>

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> = Iter<'a, T>

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

impl<T: Columnation> Default for ChunkedStack<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T: Columnation + Deserialize<'a>> Deserialize<'a> for ChunkedStack<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'a>,

Deserialize this value from the given Serde deserializer.

impl<T: Columnation> Drop for ChunkedStack<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Columnation> Index<usize> for ChunkedStack<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T: Columnation> PushInto<&T> for ChunkedStack<T>

fn push_into(&mut self, item: &T)

Push item into self.

impl<T: Columnation + Serialize> Serialize for ChunkedStack<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Columnation + 'static> SizableContainer for ChunkedStack<T>

fn capacity(&self) -> usize

Return the capacity of the container.

fn preferred_capacity() -> usize

Return the preferred capacity of the container.

fn reserve(&mut self, additional: usize)

Reserve space for additional elements, possibly increasing the capacity of the container.