Skip to main content

EntityVec

Struct EntityVec 

Source
pub struct EntityVec<I: EntityId, V> { /* private fields */ }
Expand description

A vector with strongly-typed indices.

Implementations§

Source§

impl<I: EntityId, V> EntityVec<I, V>

Source

pub fn new() -> Self

Create a new, empty EntityVec.

Source

pub fn with_capacity(cap: usize) -> Self

Source

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

Source

pub fn get_mut(&mut self, idx: I) -> Option<&mut V>

Source

pub unsafe fn get_unchecked(&self, idx: I) -> &V

Obtains a reference to a given element of the vector, without checking index validity.

§Safety

The caller must ensure that idx is a valid index within this vector.

Source

pub unsafe fn get_unchecked_mut(&mut self, idx: I) -> &mut V

Obtains a mutable reference to a given element of the vector, without checking index validity.

§Safety

The caller must ensure that idx is a valid index within this vector.

Source

pub fn push(&mut self, val: V) -> I

Appends an element, returning its index.

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn clear(&mut self)

Source

pub fn ids(&self) -> EntityRange<I>

Source

pub fn values(&self) -> Iter<'_, V> ⓘ

Source

pub fn values_mut(&mut self) -> IterMut<'_, V> ⓘ

Source

pub fn into_values(self) -> IntoIter<V> ⓘ

Source

pub fn iter(&self) -> Iter<'_, I, V> ⓘ

Source

pub fn iter_mut(&mut self) -> IterMut<'_, I, V> ⓘ

Source

pub fn map<'a, NV>(&'a self, f: impl FnMut(I, &'a V) -> NV) -> EntityVec<I, NV>

Source

pub fn map_values<'a, NV>( &'a self, f: impl FnMut(&'a V) -> NV, ) -> EntityVec<I, NV>

Source

pub fn into_map_values<NV>(self, f: impl FnMut(V) -> NV) -> EntityVec<I, NV>

Source

pub fn first(&self) -> Option<&V>

Source

pub fn first_mut(&mut self) -> Option<&mut V>

Source

pub fn first_id(&self) -> Option<I>

Source

pub fn last(&self) -> Option<&V>

Source

pub fn last_mut(&mut self) -> Option<&mut V>

Source

pub fn last_id(&self) -> Option<I>

Source

pub fn next_id(&self) -> I

See [[T]::binary_search].

Source

pub fn binary_search_by<'a, F>(&'a self, f: F) -> Result<I, I>
where F: FnMut(&'a V) -> Ordering,

See [[T]::binary_search_by].

Source

pub fn binary_search_by_key<'a, B, F>(&'a self, b: &B, f: F) -> Result<I, I>
where F: FnMut(&'a V) -> B, B: Ord,

See [[T]::binary_search_by_key].

Source

pub fn pop(&mut self) -> Option<(I, V)>

Trait Implementations§

Source§

impl<I: Clone + EntityId, V: Clone> Clone for EntityVec<I, V>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<I, V> Debug for EntityVec<I, V>
where I: EntityId, V: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<I: EntityId, V> Default for EntityVec<I, V>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<I: Eq + EntityId, V: Eq> Eq for EntityVec<I, V>

Source§

impl<I: EntityId, V> Extend<V> for EntityVec<I, V>

Source§

fn extend<T: IntoIterator<Item = V>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

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. Read more
Source§

impl<I: EntityId, V> FromIterator<V> for EntityVec<I, V>

Source§

fn from_iter<T>(iter: T) -> Self
where T: IntoIterator<Item = V>,

Creates a value from an iterator. Read more
Source§

impl<I: Hash + EntityId, V: Hash> Hash for EntityVec<I, V>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<I: EntityId, V> Index<I> for EntityVec<I, V>

Source§

type Output = V

The returned type after indexing.
Source§

fn index(&self, index: I) -> &V

Performs the indexing (container[index]) operation. Read more
Source§

impl<I: EntityId, V> IndexMut<I> for EntityVec<I, V>

Source§

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

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl<I: EntityId, V> IntoIterator for EntityVec<I, V>

Source§

type Item = (I, V)

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<I, V>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'a, I: EntityId, V> IntoIterator for &'a EntityVec<I, V>

Source§

type Item = (I, &'a V)

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, I, V>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'a, I: EntityId, V> IntoIterator for &'a mut EntityVec<I, V>

Source§

type Item = (I, &'a mut V)

The type of the elements being iterated over.
Source§

type IntoIter = IterMut<'a, I, V>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<I: Ord + EntityId, V: Ord> Ord for EntityVec<I, V>

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl<I: PartialEq + EntityId, V: PartialEq> PartialEq for EntityVec<I, V>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<I: PartialOrd + EntityId, V: PartialOrd> PartialOrd for EntityVec<I, V>

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl<I: PartialEq + EntityId, V: PartialEq> StructuralPartialEq for EntityVec<I, V>

Auto Trait Implementations§

§

impl<I, V> Freeze for EntityVec<I, V>

§

impl<I, V> RefUnwindSafe for EntityVec<I, V>

§

impl<I, V> Send for EntityVec<I, V>
where V: Send,

§

impl<I, V> Sync for EntityVec<I, V>
where V: Sync,

§

impl<I, V> Unpin for EntityVec<I, V>
where I: Unpin, V: Unpin,

§

impl<I, V> UnsafeUnpin for EntityVec<I, V>

§

impl<I, V> UnwindSafe for EntityVec<I, V>
where I: UnwindSafe, V: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.