Struct charon_lib::ids::vector::Vector

pub struct Vector<I, T>
where
    I: Idx,
{
    vector: IndexVec<I, Option<T>>,
    real_len: usize,
}

Indexed vector. To prevent accidental id reuse, the vector supports reserving a slot to be filled later.

Fields

vector: IndexVec<I, Option<T>>

real_len: usize

The number of non-None elements.

Implementations

impl<I, T> Vector<I, T>

where I: Idx,

pub fn new() -> Self

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

pub fn get_mut(&mut self, i: I) -> Option<&mut T>

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn next_id(&self) -> I

Gets the value of the next available id. Avoid if possible; use reserve_slot instead.

pub fn reserve_slot(&mut self) -> I

Reserve a spot in the vector.

pub fn set_slot(&mut self, id: I, x: T)

Fill the reserved slot.

pub fn remove(&mut self, id: I) -> Option<T>

Remove the value from this slot.

pub fn push(&mut self, x: T) -> I

pub fn push_with(&mut self, f: impl FnOnce(I) -> T) -> I

pub fn map<U>(self, f: impl FnMut(T) -> U) -> Vector<I, U>

Map each entry to a new one, keeping the same ids.

pub fn map_ref<'a, U>(&'a self, f: impl FnMut(&'a T) -> U) -> Vector<I, U>

Map each entry to a new one, keeping the same ids.

pub fn map_ref_mut<'a, U>( &'a mut self, f: impl FnMut(&'a mut T) -> U, ) -> Vector<I, U>

Map each entry to a new one, keeping the same ids.

pub fn iter(&self) -> impl Iterator<Item = &T> + Clone

Iter over the nonempty slots.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T>

pub fn iter_indexed(&self) -> impl Iterator<Item = (I, &T)>

pub fn into_iter_indexed(self) -> impl Iterator<Item = (I, T)>

pub fn iter_indexed_values(&self) -> impl Iterator<Item = (I, &T)>

pub fn into_iter_indexed_values(self) -> impl Iterator<Item = (I, T)>

pub fn iter_all_slots(&self) -> impl Iterator<Item = &Option<T>>

Iterate over all slots, even empty ones.

pub fn iter_indexed_all_slots(&self) -> impl Iterator<Item = (I, &Option<T>)>

pub fn iter_indices(&self) -> impl Iterator<Item = I> + '_

pub fn split_off(&mut self, at: usize) -> Self

Like Vec::split_off.

Trait Implementations

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

where I: Idx + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

where I: Idx + Debug,

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

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: Drive> Drive for Vector<I, T>

fn drive<V: Visitor>(&self, visitor: &mut V)

impl<I: Idx, T: DriveMut> DriveMut for Vector<I, T>

fn drive_mut<V: VisitorMut>(&mut self, visitor: &mut V)

impl<'a> Formatter<&Vector<BlockId, BlockData>> for FmtCtx<'a>

fn format_object(&self, x: &Vector<BlockId, BlockData>) -> String

impl<I, T> From<Vec<T>> for Vector<I, T>

where I: Idx,

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

Converts to this type from the input type.

impl<I, T> FromIterator<T> for Vector<I, T>

where I: Idx,

fn from_iter<It: IntoIterator<Item = T>>(iter: It) -> Vector<I, T>

Creates a value from an iterator.

impl<I, T: Hash> Hash for Vector<I, T>

where I: Idx + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I, R, T> Index<R> for Vector<I, T>

where I: Idx, R: IdxSliceIndex<I, Option<T>, Output = Option<T>>,

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<I, R, T> IndexMut<R> for Vector<I, T>

where I: Idx, R: IdxSliceIndex<I, Option<T>, Output = Option<T>>,

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

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

impl<'a, I, T> IntoIterator for &'a Vector<I, T>

where I: Idx,

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = impl Iterator<Item = &'a T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, I, T> IntoIterator for &'a mut Vector<I, T>

where I: Idx,

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = impl Iterator<Item = &'a mut 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> IntoIterator for Vector<I, T>

where I: Idx,

type Item = T

The type of the elements being iterated over.

type IntoIter = impl Iterator<Item = 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: Ord> Ord for Vector<I, T>

where I: Idx + Ord,

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

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

where I: Idx + PartialEq,

fn eq(&self, other: &Vector<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: PartialOrd> PartialOrd for Vector<I, T>

where I: Idx + PartialOrd,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

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

where I: Idx + Eq,

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

where I: Idx,