Struct id_vec::vec::IdVec

pub struct IdVec<T> { /* fields omitted */ }

Inserting elements into this map yields a persistent, type-safe Index to that new element. It does not try to preserve the order of the inserted items.

The IdVec does not actively try to preserve order of inserted elements, but a packed IdVec will append elements to the end of the internal vector.

Methods

impl<T> IdVec<T>

pub fn new() -> Self

Does not allocate heap memory

pub fn with_capacity(capacity: usize) -> Self

pub fn from_vec(elements: Vec<T>) -> Self

Create a map containing these elements. Directly uses the specified vector, so no heap allocation is made calling this function.

pub fn len(&self) -> usize

pub fn id_index_limit(&self) -> usize

Used to estimate the maximal index_value() of all ids inside this IdVec. This IdVec will not contain an id with an index value greater than or equal to this value.

pub fn capacity(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn contains_id(&self, element: Id<T>) -> bool

Excludes deleted elements, and indices out of range

pub fn is_packed(&self) -> bool

Returns if the internal vector does not contain any deleted elements

pub fn remove(&mut self, element: Id<T>)

Enable the specified id to be overwritten when a new element is inserted. This does not directly deallocate the element. Make sure that no ids pointing to that element exist after this call. Ignores invalid and deleted ids.

pub fn pop(&mut self) -> Option<(Id<T>, T)>

Removes an id and the associated element. See pop_element for more information.

pub fn pop_element(&mut self) -> Option<T>

Removes an element from this map, returns the element: Removes the one element which is the least work to remove, the one with the highest id. May deallocate unused elements. Returns None if this map is empty.

pub fn insert(&mut self, element: T) -> Id<T>

Associate the specified element with a currently unused id. This may overwrite (thus drop) unused elements.

pub fn get(&self, element: Id<T>) -> Option<&T>

Return a reference to the element that this id points to

pub fn get_mut<'s>(&'s mut self, element: Id<T>) -> Option<&'s mut T>

Return a mutable reference to the element that this id points to

pub fn swap_elements(&mut self, id1: Id<T>, id2: Id<T>)

Swap the elements pointed to. Panic on invalid Id parameter.

pub fn clear(&mut self)

Removes all elements, instantly deallocating

pub fn shrink_to_fit(&mut self)

Shrinks the internal vector itself

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

Reserve space for more elements, avoiding frequent reallocation

pub fn retain<F>(&mut self, predicate: F) where     F: Fn(Id<T>, &T) -> bool,

Retain only the elements specified by the predicate. May deallocate unused elements.

pub fn pack<F>(&mut self, remap: F) where     F: FnMut(Id<T>, Id<T>),

Make this map have a continuous flow of indices, having no wasted allocation and calling remap(old_id, new_id) for every element that has been moved to a new Id It does not preserve order of the inserted items.

Important traits for Iter<'s, T>

impl<'s, T: 's> Iterator for Iter<'s, T> type Item = (Id<T>, &'s T);

pub fn iter<'s>(&'s self) -> Iter<'s, T>

Used for immutable access to ids and elements

Important traits for IntoElements<T>

impl<T> Iterator for IntoElements<T> type Item = T;

pub fn into_elements(self) -> IntoElements<T>

Iterate over the elements, consuming this IdVec

Important traits for DrainElements<'s, T>

impl<'s, T: 's> Iterator for DrainElements<'s, T> type Item = T;

pub fn drain_elements(&mut self) -> DrainElements<T>

Iterate over the elements, clearing this IdVec

Important traits for ElementIter<'s, T>

impl<'s, T: 's> Iterator for ElementIter<'s, T> type Item = &'s T;

pub fn elements<'s>(&'s self) -> ElementIter<'s, T>

Used for immutable direct access to all used elements

Important traits for IdIter<'s, T>

impl<'s, T: 's> Iterator for IdIter<'s, T> type Item = Id<T>;

pub fn ids<'s>(&'s self) -> IdIter<'s, T>

Used for immutable indirect access

Important traits for OwnedIdIter<T>

impl<T> Iterator for OwnedIdIter<T> type Item = Id<T>;

pub fn get_ids(&self) -> OwnedIdIter<T>

Used for full mutable access, while allowing inserting and deleting while iterating. The iterator will keep an independent state, in order to un-borrow the underlying map. This may be more expensive than iter, because it needs to clone the internal set of unused ids.

pub fn ids_eq(&self, other: &Self) -> bool

Compares if two id-maps contain the same ids, ignoring elements. Complexity of O(n)

pub fn elements_eq(&self, other: &Self) -> bool where     T: PartialEq,

Compares if two id-maps contain the same elements, ignoring ids. Worst case complexity of O(n^2)

pub fn contains_element(&self, element: &T) -> bool where     T: PartialEq,

Worst case complexity of O(n)

pub fn find_id_of_element(&self, element: &T) -> Option<Id<T>> where     T: PartialEq,

Worst case complexity of O(n)

Trait Implementations

impl<T: Clone> Clone for IdVec<T>

fn clone(&self) -> IdVec<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Default> Default for IdVec<T>

fn default() -> IdVec<T>

Returns the "default value" for a type.

impl<T> FromIterator<T> for IdVec<T>

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

Creates a value from an iterator.

impl<T> IntoIterator for IdVec<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoElements<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> From<Vec<T>> for IdVec<T>

fn from(vec: Vec<T>) -> Self

Performs the conversion.

impl<T> Index<Id<T>> for IdVec<T>

type Output = T

The returned type after indexing.

fn index(&self, element: Id<T>) -> &T

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Id<T>> for IdVec<T>

fn index_mut(&mut self, element: Id<T>) -> &mut T

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

impl<T> Eq for IdVec<T> where     T: Eq,

Equality means: The same Ids pointing to the same elements, ignoring deleted elements. Complexity of O(n)

impl<T> PartialEq for IdVec<T> where     T: PartialEq,

fn eq(&self, other: &Self) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T> Debug for IdVec<T> where     T: Debug,

fn fmt(&self, formatter: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.