phf::map

Struct Map

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

An immutable map constructed at compile time.

§Note

The fields of this struct are public so that they may be initialized by the phf_map! macro and code generation. They are subject to change at any time and should never be accessed directly.

Implementations§

Source§

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

Source

pub const fn new() -> Self

Create a new, empty, immutable map.

Source

pub const fn len(&self) -> usize

Returns the number of entries in the Map.

Source

pub const fn is_empty(&self) -> bool

Returns true if the Map is empty.

Source

pub fn contains_key<T>(&self, key: &T) -> bool
where T: Eq + PhfHash + ?Sized, K: PhfBorrow<T>,

Determines if key is in the Map.

Source

pub fn get<T>(&self, key: &T) -> Option<&V>
where T: Eq + PhfHash + ?Sized, K: PhfBorrow<T>,

Returns a reference to the value that key maps to.

Source

pub fn get_key<T>(&self, key: &T) -> Option<&K>
where T: Eq + PhfHash + ?Sized, K: PhfBorrow<T>,

Returns a reference to the map’s internal static instance of the given key.

This can be useful for interning schemes.

Source

pub fn get_entry<T>(&self, key: &T) -> Option<(&K, &V)>
where T: Eq + PhfHash + ?Sized, K: PhfBorrow<T>,

Like get, but returns both the key and the value.

Source

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

Returns an iterator over the key/value pairs in the map.

Entries are returned in an arbitrary but fixed order.

Source

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

Returns an iterator over the keys in the map.

Keys are returned in an arbitrary but fixed order.

Source

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

Returns an iterator over the values in the map.

Values are returned in an arbitrary but fixed order.

Trait Implementations§

Source§

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

Source§

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

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<'a, K, V, T> Index<&'a T> for Map<K, V>
where T: Eq + PhfHash + ?Sized, K: PhfBorrow<T>,

Source§

type Output = V

The returned type after indexing.
Source§

fn index(&self, k: &'a T) -> &V

Performs the indexing (container[index]) operation. Read more
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 = Entries<'a, K, V>

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

fn into_iter(self) -> Entries<'a, K, V>

Creates an iterator from a value. Read more

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, V: Sync,

§

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

§

impl<K, V> Unpin 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> 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, 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.