Skip to main content

EntityPartVec

Struct EntityPartVec 

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

A partial map backed by a vector.

An EntityPartVec stores at most one value V for each index I. Conceptually, this is similar to e.g. a BTreeMap<I, V>.

Under the hood, this is backed by a Vec<Option<V>>. Thus, ideally the type V should have a niche in its layout.

Implementations§

Source§

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

Source

pub fn new() -> Self

Source

pub fn with_capacity(cap: usize) -> Self

Source

pub fn is_empty(&self) -> bool

Source

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

Source

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

Source

pub fn contains_id(&self, id: I) -> bool

Source

pub fn clear(&mut self)

Source

pub fn insert(&mut self, id: I, val: V) -> Option<V>

Inserts the value val at position id, returning the previous value, if any.

Source

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

Remove the value at position id.

Source

pub fn ids(&self) -> Ids<'_, I, V> ⓘ

Returns iterator of IDs for which values are present.

Source

pub fn into_ids(self) -> IntoIds<I, V> ⓘ

Source

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

Returns an iterator of (id, &value) pairs.

IDs not present are skipped entirely.

Source

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

Returns an iterator of (id, &mut value) pairs.

IDs not present are skipped entirely.

Source

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

Source

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

Source

pub fn into_values(self) -> IntoValues<I, V> ⓘ

Source

pub fn into_full(self) -> EntityVec<I, V>

Converts into an EntityVec without holes.

If values are present for all IDs between 0 and the highest ID present, that is, if there aren’t any “holes” in the middle, then convert to a EntityVec which expresses this fact statically. Otherwise, panic.

Source

pub fn try_into_full(self) -> Result<EntityVec<I, V>, I>

Converts into an EntityVec without holes.

If values are present for all IDs between 0 and the highest ID present, that is, if there aren’t any “holes” in the middle, then convert to a EntityVec which expresses this fact statically. Otherwise, return the lowest ID at which a hole was found.

Source

pub fn map<O>(&self, f: impl FnMut(I, &V) -> O) -> EntityPartVec<I, O>

Source

pub fn map_values<O>(&self, f: impl FnMut(&V) -> O) -> EntityPartVec<I, O>

Trait Implementations§

Source§

impl<I: Clone + EntityId, V: Clone> Clone for EntityPartVec<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 EntityPartVec<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 EntityPartVec<I, V>

Source§

fn default() -> Self

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

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

Source§

impl<I: EntityId, V> Extend<(I, V)> for EntityPartVec<I, V>

Source§

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

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<(I, V)> for EntityPartVec<I, V>

Source§

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

Creates a value from an iterator. Read more
Source§

impl<I: Hash + EntityId, V: Hash> Hash for EntityPartVec<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 EntityPartVec<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 EntityPartVec<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 EntityPartVec<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 EntityPartVec<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 EntityPartVec<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: PartialEq + EntityId, V: PartialEq> PartialEq for EntityPartVec<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: PartialEq + EntityId, V: PartialEq> StructuralPartialEq for EntityPartVec<I, V>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

§

impl<I, V> UnwindSafe for EntityPartVec<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> 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.