Skip to main content

Map

Struct Map 

Source
pub struct Map<K: 'static, V: 'static> { /* private fields */ }
Expand description

An immutable map.

Construct one with From or FromIterator.

Implementations§

Source§

impl<K, V> Map<K, V>

Source

pub fn get_entry<Q>(&self, key: &Q) -> Option<(&K, &V)>
where Q: Hash + Eq + ?Sized, K: Borrow<Q>,

Returns the key-value entry corresponding to the given key, if present.

Source

pub fn get<Q>(&self, key: &Q) -> Option<&V>
where Q: Hash + Eq + ?Sized, K: Borrow<Q>,

Returns a reference to the value corresponding to the given key, if present.

Source

pub fn contains_key<Q>(&self, key: &Q) -> bool
where Q: Hash + Eq + ?Sized, K: Borrow<Q>,

Returns true if the map contains an entry for the given key.

Source

pub fn len(&self) -> usize

Returns the number of entries in the map.

Source

pub fn is_empty(&self) -> bool

Returns true if the map contains no entries.

Source

pub fn entries(&self) -> MapEntries<'_, K, V>

Returns an iterator over the key-value pairs of the map in an unspecified order.

Source

pub fn keys(&self) -> MapKeys<'_, K, V>

Returns an iterator over the keys of the map in an unspecified order.

Source

pub fn values(&self) -> MapValues<'_, K, V>

Returns an iterator over the values of the map in an unspecified order.

Source§

impl<K, V> Map<K, V>
where K: Bake, V: Bake,

Source

pub fn to_tokens(&self) -> TokenStream

Available on crate feature codegen only.

Serializes the Map into a token stream of literal Rust code that reconstructs it. Used for embedding in generated code.

Trait Implementations§

Source§

impl<K, V> Bake for Map<K, V>
where K: Bake, V: Bake,

Available on crate feature codegen only.
Source§

fn bake(&self, ctx: &CrateEnv) -> TokenStream

Returns a TokenStream that would evaluate to self. Read more
Source§

impl<K: Clone + 'static, V: Clone + 'static> Clone for Map<K, V>

Source§

fn clone(&self) -> Map<K, V>

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<K: Debug, V: Debug> Debug for Map<K, V>

Source§

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

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

impl<K, V> Default for Map<K, V>

Source§

fn default() -> Self

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

impl<K, V> Eq for Map<K, V>
where K: Eq + Hash, V: Eq,

Source§

impl<K, V, const N: usize> From<[(K, V); N]> for Map<K, V>
where K: Eq + Hash,

Available on crate feature construct only.
Source§

fn from(entries: [(K, V); N]) -> Self

§Panics

Panics if:

  • there are more than 65535 entries
  • any duplicate keys are present
  • no perfect hash function can be found for the keys
Source§

impl<K, V> FromIterator<(K, V)> for Map<K, V>
where K: Eq + Hash,

Available on crate feature construct only.
Source§

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

§Panics

Panics if:

  • there are more than 65535 entries
  • any duplicate keys are present
  • no perfect hash function can be found for the keys
Source§

impl<Q, K, V> Index<&Q> for Map<K, V>
where Q: Hash + Eq + ?Sized, K: Borrow<Q>,

Source§

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

§Panics

Panics if there is no entry for the given key.

Source§

type Output = V

The returned type after indexing.
Source§

impl<'a, K, V> IntoIterator for &'a Map<K, V>

Source§

type Item = (&'a K, &'a V)

The type of the elements being iterated over.
Source§

type IntoIter = MapEntries<'a, K, 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<K, V> PartialEq for Map<K, V>
where K: Eq + Hash, V: PartialEq,

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Auto Trait Implementations§

§

impl<K, V> Freeze for Map<K, V>

§

impl<K, V> RefUnwindSafe for Map<K, V>

§

impl<K, V> Send for Map<K, V>
where K: Sync + Send, V: Sync + Send,

§

impl<K, V> Sync for Map<K, V>
where K: Sync, V: Sync,

§

impl<K, V> Unpin for Map<K, V>
where K: Unpin, V: Unpin,

§

impl<K, V> UnsafeUnpin for Map<K, V>

§

impl<K, V> UnwindSafe for Map<K, V>

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
Source§

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

Source§

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

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

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

Source§

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.