Struct IndexVec 

pub struct IndexVec<I: Idx, T> { /* private fields */ }

A dense vector indexed by ID types.

This provides O(1) access and storage for dense ID-indexed data.

Implementations

impl<I: Idx, T> IndexVec<I, T>

pub fn new() -> Self

Create a new empty IndexVec.

pub fn with_capacity(n: usize) -> Self

Create a new IndexVec with pre-allocated capacity.

pub fn len(&self) -> usize

Get the number of elements in the IndexVec.

pub fn is_empty(&self) -> bool

Check if the IndexVec is empty.

pub fn push(&mut self, v: T) -> Result<I, IndexedVecError>

Push an element and return its ID.

Returns an error if the length would exceed the maximum representable by the ID type.

pub fn get(&self, idx: I) -> Option<&T>

Get an element by ID, returning None if the ID is out of bounds.

pub fn as_slice(&self) -> &[T]

Get a slice of all elements.

pub fn into_inner(self) -> Vec<T>

Consume this IndexVec and return the underlying Vec.

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

Remove an element at the specified index and return it.

pub fn contains(&self, item: &T) -> bool

where T: PartialEq,

Check if this IndexVec contains a specific element.

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

Get an iterator over the elements in this IndexVec.

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Get a mutable iterator over the elements in this IndexVec.

Trait Implementations

impl<I: Clone + Idx, T: Clone> Clone for IndexVec<I, T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Debug + Idx, T: Debug> Debug for IndexVec<I, T>

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

Formats the value using the given formatter.

impl<I: Idx, T> Default for IndexVec<I, T>

fn default() -> Self

Returns the “default value” for a type.

impl<I, T> Deserializable for IndexVec<I, T>

where I: Idx, T: Deserializable,

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl<'de, I: Idx, T> Deserialize<'de> for IndexVec<I, T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<I: Idx, T> Index<I> for IndexVec<I, T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<I: Idx, T> IndexMut<I> for IndexVec<I, T>

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

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

impl<'a, I: Idx, T> IntoIterator for &'a IndexVec<I, T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<I: Idx, T> IntoIterator for IndexVec<I, T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<I, T> LookupByIdx<I, T> for IndexVec<I, T>

where I: Idx,

fn get(&self, id: I) -> Option<&T>

Get the value for the given ID.

impl<I: PartialEq + Idx, T: PartialEq> PartialEq for IndexVec<I, T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<I, T> Serializable for IndexVec<I, T>

where I: Idx, T: Serializable,

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl<I: Idx, T> Serialize for IndexVec<I, T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<I: Idx, T> TryFrom<Vec<T>> for IndexVec<I, T>

fn try_from(raw: Vec<T>) -> Result<Self, Self::Error>

Create an IndexVec from a Vec.

Returns an error if the Vec length exceeds u32::MAX.

type Error = IndexedVecError

The type returned in the event of a conversion error.

impl<I: Eq + Idx, T: Eq> Eq for IndexVec<I, T>

impl<I: Idx, T> StructuralPartialEq for IndexVec<I, T>