Struct pui_vec::PuiVec

pub struct PuiVec<T, I> { /* fields omitted */ }

An append only Vec whitch returns branded indicies that can be used to elide bounds checks.

Implementations

impl<T, I> PuiVec<T, I>

pub const fn new(ident: I) -> Self

Creates a new PuiVec with the given identifier

pub const fn from_raw_parts(vec: Vec<T>, ident: I) -> Self

Creates a new PuiVec with the given identifier and Vec

pub const fn ident(&self) -> &I

Returns a reference to the underlying identifier

pub fn is_empty(&self) -> bool

Returns true if this PuiVec is empty

pub fn len(&self) -> usize

Returns the length of this PuiVec

pub fn capacity(&self) -> usize

Returns the capacity of this PuiVec

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

Reserves capacity for at least additional more elements to be inserted in the given collection. The collection may reserve more space to avoid frequent reallocations. After calling reserve, capacity will be greater than or equal to self.len() + additional. Does nothing if capacity is already sufficient.

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

Reserves the minimum capacity for exactly additional more elements to be inserted in the given collection. After calling reserve_exact, capacity will be greater than or equal to self.len() + additional. Does nothing if the capacity is already sufficient.

Note that the allocator may give the collection more space than it requests. Therefore, capacity can not be relied upon to be precisely minimal. Prefer reserve if future insertions are expected.

pub fn get<A: PuiVecAccess<T, I>>(&self, index: A) -> Option<&A::Output>

Returns a reference to an element or subslice depending on the type of index.

• If given a position, returns a reference to the element at that position or None if out of bounds.
• If given a range, returns the subslice corresponding to that range, or None if out of bounds.
• If given a Id, returns a reference to the element at that position
• If given a range of Id, returns a the subslice corresponding to that range

pub fn get_mut<A: PuiVecAccess<T, I>>(
    &mut self,
    index: A
) -> Option<&mut A::Output>

Returns a mutable reference to an element or subslice depending on the type of index. See get for details

pub fn as_mut_parts(&mut self) -> (&I, &mut [T])

Returns a reference to the identifier and a mutable reference to the underlying slice

pub unsafe fn into_raw_parts(self) -> (I, Vec<T>)

Decomposes PuiVec into a it's identifier and it's underling Vec

Safety

The identifier can't be used to create a new PuiVec

impl<T> PuiVec<T, ()>

pub fn vec_mut(&mut self) -> &mut Vec<T>

Get a mutable reference to the underling Vec

impl<T, I> PuiVec<T, I>

pub fn push<Id: BuildPuiVecIndex<I, SliceIndex = usize>>(
    &mut self,
    value: T
) -> Id

Appends an element to the back of a collection.

Returns an Id or usize

pub fn append(&mut self, vec: &mut Vec<T>)

Moves all the elements of other into Self, leaving other empty.

pub fn extend_from_slice(&mut self, slice: &[T]) where
    T: Clone, 

Clones and appends all elements in a slice to the PuiVec.

Iterates over the slice other, clones each element, and then appends it to this Vec. The other vector is traversed in-order.

Note that this function is same as extend except that it is specialized to work with slices instead. If and when Rust gets specialization this function will likely be deprecated (but still available).

impl<T, I: OneShotIdentifier> PuiVec<T, I>

pub fn ids(&self) -> impl ExactSizeIterator<Item = Id<I::Token>> + Clone

Returns an iterator over all the ids in the PuiVec

pub fn parse_id(&self, index: usize) -> Option<Id<I::Token>>

check if the index is in bounds, and if it is, return the corrosponding Id

pub fn swap(&mut self, a: Id<I::Token>, b: Id<I::Token>)

swap two elements, while eliding bounds checks

pub fn split_at(&self, mid: Id<I::Token>) -> (&[T], &[T])

Divides the PuiVec into two slices at an index, while eliding bounds checks.

The first will contain all indices from [0, mid) (excluding the index mid itself) and the second will contain all indices from [mid, len) (excluding the index len itself).

pub fn split_at_mut(&mut self, id: Id<I::Token>) -> (&mut [T], &mut [T])

Divides the PuiVec into two slices at an index, while eliding bounds checks.

The first will contain all indices from [0, mid) (excluding the index mid itself) and the second will contain all indices from [mid, len) (excluding the index len itself).

Trait Implementations

impl<T: Clone, I: Clone> Clone for PuiVec<T, I>

pub fn clone(&self) -> PuiVec<T, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, I: Debug> Debug for PuiVec<T, I>

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

Formats the value using the given formatter.

impl<T, I> Deref for PuiVec<T, I>

type Target = [T]

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, I> DerefMut for PuiVec<T, I>

pub fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Eq, I: Eq> Eq for PuiVec<T, I>

impl<A, T, I> Extend<A> for PuiVec<T, I> where
    Vec<T>: Extend<A>, 

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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<T, I, A> Index<A> for PuiVec<T, I> where
    A: PuiVecAccess<T, I>, 

type Output = A::Output

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, I, A> IndexMut<A> for PuiVec<T, I> where
    A: PuiVecAccess<T, I>, 

pub fn index_mut(&mut self, index: A) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T, I> IntoIterator for PuiVec<T, I>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Ord, I: Ord> Ord for PuiVec<T, I>

pub fn cmp(&self, other: &PuiVec<T, I>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq, I: PartialEq> PartialEq<PuiVec<T, I>> for PuiVec<T, I>

pub fn eq(&self, other: &PuiVec<T, I>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &PuiVec<T, I>) -> bool

This method tests for !=.

impl<T: PartialOrd, I: PartialOrd> PartialOrd<PuiVec<T, I>> for PuiVec<T, I>

pub fn partial_cmp(&self, other: &PuiVec<T, I>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &PuiVec<T, I>) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &PuiVec<T, I>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &PuiVec<T, I>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &PuiVec<T, I>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T, I> StructuralEq for PuiVec<T, I>

impl<T, I> StructuralPartialEq for PuiVec<T, I>