Struct cranelift_entity::PrimaryMap
source · [−]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
sourceimpl<K, V> PrimaryMap<K, V> where
K: EntityRef,
impl<K, V> PrimaryMap<K, V> where
K: EntityRef,
sourcepub fn with_capacity(capacity: usize) -> Self
pub fn with_capacity(capacity: usize) -> Self
Create a new empty map with the given capacity.
sourcepub 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.
sourcepub fn keys(&self) -> Keys<K>ⓘNotable traits for Keys<K>impl<K: EntityRef> Iterator for Keys<K> type Item = K;
pub fn keys(&self) -> Keys<K>ⓘNotable traits for Keys<K>impl<K: EntityRef> Iterator for Keys<K> type Item = K;
Iterate over all the keys in this map.
sourcepub 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.
sourcepub fn iter(&self) -> Iter<'_, K, V>ⓘNotable traits for Iter<'a, K, V>impl<'a, K: EntityRef, V> Iterator for Iter<'a, K, V> type Item = (K, &'a V);
pub fn iter(&self) -> Iter<'_, K, V>ⓘNotable traits for Iter<'a, K, V>impl<'a, K: EntityRef, V> Iterator for Iter<'a, K, V> type Item = (K, &'a V);
Iterate over all the keys and values in this map.
sourcepub fn iter_mut(&mut self) -> IterMut<'_, K, V>ⓘNotable traits for IterMut<'a, K, V>impl<'a, K: EntityRef, V> Iterator for IterMut<'a, K, V> type Item = (K, &'a mut V);
pub fn iter_mut(&mut self) -> IterMut<'_, K, V>ⓘNotable traits for IterMut<'a, K, V>impl<'a, K: EntityRef, V> Iterator for IterMut<'a, K, V> type Item = (K, &'a mut V);
Iterate over all the keys and values in this map, mutable edition.
sourcepub 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.
sourcepub 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.
sourcepub fn reserve(&mut self, additional: usize)
pub fn reserve(&mut self, additional: usize)
Reserves capacity for at least additional
more elements to be inserted.
sourcepub 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.
sourcepub fn shrink_to_fit(&mut self)
pub fn shrink_to_fit(&mut self)
Shrinks the capacity of the PrimaryMap
as much as possible.
sourcepub fn into_boxed_slice(self) -> BoxedSlice<K, V>
pub fn into_boxed_slice(self) -> BoxedSlice<K, V>
Consumes this PrimaryMap
and produces a BoxedSlice
.
sourcepub fn binary_search_values_by_key<'a, B, F>(
&'a self,
b: &B,
f: F
) -> Result<K, K> where
F: FnMut(&'a V) -> B,
B: Ord,
pub fn binary_search_values_by_key<'a, B, F>(
&'a self,
b: &B,
f: F
) -> Result<K, K> where
F: FnMut(&'a V) -> B,
B: Ord,
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
sourceimpl<K: Clone, V: Clone> Clone for PrimaryMap<K, V> where
K: EntityRef,
impl<K: Clone, V: Clone> Clone for PrimaryMap<K, V> where
K: EntityRef,
sourcefn clone(&self) -> PrimaryMap<K, V>
fn clone(&self) -> PrimaryMap<K, V>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<K, V> Default for PrimaryMap<K, V> where
K: EntityRef,
impl<K, V> Default for PrimaryMap<K, V> where
K: EntityRef,
sourcefn default() -> PrimaryMap<K, V>
fn default() -> PrimaryMap<K, V>
Returns the “default value” for a type. Read more
sourceimpl<'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>,
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl<K, V> FromIterator<V> for PrimaryMap<K, V> where
K: EntityRef,
impl<K, V> FromIterator<V> for PrimaryMap<K, V> where
K: EntityRef,
sourcefn from_iter<T>(iter: T) -> Self where
T: IntoIterator<Item = V>,
fn from_iter<T>(iter: T) -> Self where
T: IntoIterator<Item = V>,
Creates a value from an iterator. Read more
sourceimpl<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.
sourceimpl<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
.
sourceimpl<K, V> IntoIterator for PrimaryMap<K, V> where
K: EntityRef,
impl<K, V> IntoIterator for PrimaryMap<K, V> where
K: EntityRef,
sourceimpl<'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,
sourceimpl<'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,
sourceimpl<K: PartialEq, V: PartialEq> PartialEq<PrimaryMap<K, V>> for PrimaryMap<K, V> where
K: EntityRef,
impl<K: PartialEq, V: PartialEq> PartialEq<PrimaryMap<K, V>> for PrimaryMap<K, V> where
K: EntityRef,
sourcefn eq(&self, other: &PrimaryMap<K, V>) -> bool
fn eq(&self, other: &PrimaryMap<K, V>) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &PrimaryMap<K, V>) -> bool
fn ne(&self, other: &PrimaryMap<K, V>) -> bool
This method tests for !=
.
sourceimpl<K, V> Serialize for PrimaryMap<K, V> where
K: EntityRef,
V: Serialize,
impl<K, V> Serialize for PrimaryMap<K, V> where
K: EntityRef,
V: Serialize,
impl<K: Eq, V: Eq> Eq for PrimaryMap<K, V> where
K: EntityRef,
impl<K, V> StructuralEq for PrimaryMap<K, V> where
K: EntityRef,
impl<K, V> StructuralPartialEq for PrimaryMap<K, V> where
K: EntityRef,
Auto Trait Implementations
impl<K, V> RefUnwindSafe for PrimaryMap<K, V> where
K: RefUnwindSafe,
V: RefUnwindSafe,
impl<K, V> Send for PrimaryMap<K, V> where
K: Send,
V: Send,
impl<K, V> Sync for PrimaryMap<K, V> where
K: Sync,
V: Sync,
impl<K, V> Unpin for PrimaryMap<K, V> where
K: Unpin,
V: Unpin,
impl<K, V> UnwindSafe for PrimaryMap<K, V> where
K: UnwindSafe,
V: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more