Struct PrimaryMap
pub struct PrimaryMap<K, V>where
K: EntityRef,{ /* private fields */ }
Expand description
A primary mapping K -> V
allocating dense entity references.
The PrimaryMap
data structure uses the dense index space to implement a map with a vector.
A primary map contains the main definition of an entity, and it can be used to allocate new
entity references with the push
method.
There should only be a single PrimaryMap
instance for a given EntityRef
type, otherwise
conflicting references will be created. Using unknown keys for indexing will cause a panic.
Note that PrimaryMap
doesn’t implement Deref
or DerefMut
, which would allow
&PrimaryMap<K, V>
to convert to &[V]
. One of the main advantages of PrimaryMap
is
that it only allows indexing with the distinct EntityRef
key type, so converting to a
plain slice would make it easier to use incorrectly. To make a slice of a PrimaryMap
, use
into_boxed_slice
.
Implementations§
§impl<K, V> PrimaryMap<K, V>where
K: EntityRef,
impl<K, V> PrimaryMap<K, V>where
K: EntityRef,
pub fn new() -> PrimaryMap<K, V>
pub fn new() -> PrimaryMap<K, V>
Create a new empty map.
pub fn with_capacity(capacity: usize) -> PrimaryMap<K, V>
pub fn with_capacity(capacity: usize) -> PrimaryMap<K, V>
Create a new empty map with the given capacity.
pub fn get_mut(&mut self, k: K) -> Option<&mut V>
pub fn get_mut(&mut self, k: K) -> Option<&mut V>
Get the element at k
if it exists, mutable version.
pub fn values_mut(&mut self) -> IterMut<'_, V> ⓘ
pub fn values_mut(&mut self) -> IterMut<'_, V> ⓘ
Iterate over all the values in this map, mutable edition.
pub fn iter_mut(&mut self) -> IterMut<'_, K, V> ⓘ
pub fn iter_mut(&mut self) -> IterMut<'_, K, V> ⓘ
Iterate over all the keys and values in this map, mutable edition.
pub fn clear(&mut self)
pub fn clear(&mut self)
Remove all entries from this map.
pub fn next_key(&self) -> K
pub fn next_key(&self) -> K
Get the key that will be assigned to the next pushed value.
pub fn push(&mut self, v: V) -> K
pub fn push(&mut self, v: V) -> K
Append v
to the mapping, assigning a new key which is returned.
pub fn last_mut(&mut self) -> Option<(K, &mut V)>
pub fn last_mut(&mut self) -> Option<(K, &mut V)>
Returns the last element that was inserted in the map.
pub fn reserve(&mut self, additional: usize)
pub fn reserve(&mut self, additional: usize)
Reserves capacity for at least additional
more elements to be inserted.
pub fn reserve_exact(&mut self, additional: usize)
pub fn reserve_exact(&mut self, additional: usize)
Reserves the minimum capacity for exactly additional
more elements to be inserted.
pub fn shrink_to_fit(&mut self)
pub fn shrink_to_fit(&mut self)
Shrinks the capacity of the PrimaryMap
as much as possible.
pub fn into_boxed_slice(self) -> BoxedSlice<K, V>
pub fn into_boxed_slice(self) -> BoxedSlice<K, V>
Consumes this PrimaryMap
and produces a BoxedSlice
.
pub fn get_many_mut<const N: usize>(
&mut self,
indices: [K; N],
) -> Result<[&mut V; N], GetManyMutError<K>>
pub fn get_many_mut<const N: usize>( &mut self, indices: [K; N], ) -> Result<[&mut V; N], GetManyMutError<K>>
Returns mutable references to many elements at once.
Returns an error if an element does not exist, or if the same key was passed more than once.
pub fn binary_search_values_by_key<'a, B, F>(
&'a self,
b: &B,
f: F,
) -> Result<K, K>
pub fn binary_search_values_by_key<'a, B, F>( &'a self, b: &B, f: F, ) -> Result<K, K>
Performs a binary search on the values with a key extraction function.
Assumes that the values are sorted by the key extracted by the function.
If the value is found then Ok(K)
is returned, containing the entity key
of the matching value.
If there are multiple matches, then any one of the matches could be returned.
If the value is not found then Err(K) is returned, containing the entity key where a matching element could be inserted while maintaining sorted order.
Trait Implementations§
§impl<K, V> Clone for PrimaryMap<K, V>
impl<K, V> Clone for PrimaryMap<K, V>
§fn clone(&self) -> PrimaryMap<K, V>
fn clone(&self) -> PrimaryMap<K, V>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl<K, V> Debug for PrimaryMap<K, V>
impl<K, V> Debug for PrimaryMap<K, V>
§impl<K, V> Default for PrimaryMap<K, V>where
K: EntityRef,
impl<K, V> Default for PrimaryMap<K, V>where
K: EntityRef,
§fn default() -> PrimaryMap<K, V>
fn default() -> PrimaryMap<K, V>
§impl<'de, K, V> Deserialize<'de> for PrimaryMap<K, V>where
K: EntityRef,
V: Deserialize<'de>,
impl<'de, K, V> Deserialize<'de> for PrimaryMap<K, V>where
K: EntityRef,
V: Deserialize<'de>,
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<PrimaryMap<K, V>, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<PrimaryMap<K, V>, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
§impl<K, V> From<Vec<V>> for PrimaryMap<K, V>where
K: EntityRef,
impl<K, V> From<Vec<V>> for PrimaryMap<K, V>where
K: EntityRef,
§fn from(elems: Vec<V>) -> PrimaryMap<K, V>
fn from(elems: Vec<V>) -> PrimaryMap<K, V>
§impl<K, V> FromIterator<V> for PrimaryMap<K, V>where
K: EntityRef,
impl<K, V> FromIterator<V> for PrimaryMap<K, V>where
K: EntityRef,
§fn from_iter<T>(iter: T) -> PrimaryMap<K, V>where
T: IntoIterator<Item = V>,
fn from_iter<T>(iter: T) -> PrimaryMap<K, V>where
T: IntoIterator<Item = V>,
§impl<K, V> Hash for PrimaryMap<K, V>
impl<K, V> Hash for PrimaryMap<K, V>
§impl<K, V> Index<K> for PrimaryMap<K, V>where
K: EntityRef,
impl<K, V> Index<K> for PrimaryMap<K, V>where
K: EntityRef,
Immutable indexing into an PrimaryMap
.
The indexed value must be in the map.
§impl<K, V> IndexMut<K> for PrimaryMap<K, V>where
K: EntityRef,
impl<K, V> IndexMut<K> for PrimaryMap<K, V>where
K: EntityRef,
Mutable indexing into an PrimaryMap
.
§impl<'a, K, V> IntoIterator for &'a PrimaryMap<K, V>where
K: EntityRef,
impl<'a, K, V> IntoIterator for &'a PrimaryMap<K, V>where
K: EntityRef,
§impl<'a, K, V> IntoIterator for &'a mut PrimaryMap<K, V>where
K: EntityRef,
impl<'a, K, V> IntoIterator for &'a mut PrimaryMap<K, V>where
K: EntityRef,
§impl<K, V> IntoIterator for PrimaryMap<K, V>where
K: EntityRef,
impl<K, V> IntoIterator for PrimaryMap<K, V>where
K: EntityRef,
§impl<K, V> PartialEq for PrimaryMap<K, V>
impl<K, V> PartialEq for PrimaryMap<K, V>
§impl<K, V> Serialize for PrimaryMap<K, V>
impl<K, V> Serialize for PrimaryMap<K, V>
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl<K, V> Eq for PrimaryMap<K, V>
impl<K, V> StructuralPartialEq for PrimaryMap<K, V>where
K: EntityRef,
Auto Trait Implementations§
impl<K, V> Freeze for PrimaryMap<K, V>
impl<K, V> RefUnwindSafe for PrimaryMap<K, V>where
K: RefUnwindSafe,
V: RefUnwindSafe,
impl<K, V> Send for PrimaryMap<K, V>
impl<K, V> Sync for PrimaryMap<K, V>
impl<K, V> Unpin for PrimaryMap<K, V>
impl<K, V> UnwindSafe for PrimaryMap<K, V>where
K: UnwindSafe,
V: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.