Struct Map 

pub struct Map<K, V>(/* private fields */);

The map used to store the properties of a JsonObject.

The backing implementation and hasher are selected by the preserve_order and fast_hash cargo features, but this type exposes the same API regardless of which are enabled. It’s meant to be a drop-in replacement for the standard library’s HashMap.

Implementations

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

pub fn new() -> Self

Creates an empty map.

pub fn with_capacity(capacity: usize) -> Self

Creates an empty map with at least the specified capacity.

pub fn len(&self) -> usize

Gets the number of entries.

pub fn is_empty(&self) -> bool

Gets if there are no entries.

pub fn capacity(&self) -> usize

Gets the number of entries the map can hold without reallocating.

pub fn clear(&mut self)

Removes all entries.

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

Iterates over the entries.

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

Iterates over the entries with mutable references to the values.

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

Iterates over the keys.

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

Iterates over the values.

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

Iterates over mutable references to the values.

pub fn into_keys(self) -> IntoKeys<K, V>

Consumes the map, iterating over its keys.

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

Consumes the map, iterating over its values.

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

pub fn insert(&mut self, key: K, value: V) -> Option<V>

Inserts an entry, returning the previous value for the key if it existed.

pub fn entry(&mut self, key: K) -> Entry<'_, K, V>

Gets the entry for the given key for in-place manipulation.

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more entries.

pub fn retain<F: FnMut(&K, &mut V) -> bool>(&mut self, f: F)

Retains only the entries for which the predicate returns true.

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

pub fn get<Q>(&self, key: &Q) -> Option<&V>

where Q: Hash + Equivalent<K> + ?Sized,

Gets a reference to the value for the given key.

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>

where Q: Hash + Equivalent<K> + ?Sized,

Gets a mutable reference to the value for the given key.

pub fn get_key_value<Q>(&self, key: &Q) -> Option<(&K, &V)>

where Q: Hash + Equivalent<K> + ?Sized,

Gets the key and value for the given key.

pub fn contains_key<Q>(&self, key: &Q) -> bool

where Q: Hash + Equivalent<K> + ?Sized,

Gets if the map contains the given key.

pub fn remove<Q>(&mut self, key: &Q) -> Option<V>

where Q: Hash + Equivalent<K> + ?Sized,

Removes and returns the value for the given key, preserving the order of the remaining entries.

pub fn remove_entry<Q>(&mut self, key: &Q) -> Option<(K, V)>

where Q: Hash + Equivalent<K> + ?Sized,

Removes and returns the entry for the given key, preserving the order of the remaining entries.

Trait Implementations

impl<K: Clone, V: Clone> Clone for Map<K, V>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

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

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

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.

impl<'a> From<Map<Cow<'a, str>, JsonValue<'a>>> for JsonObject<'a>

fn from(properties: Map<Cow<'a, str>, JsonValue<'a>>) -> JsonObject<'a>

Converts to this type from the input type.

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

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

Creates a value from an iterator.

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

Available on crate feature preserve_order only.

type Output = V

The returned type after indexing.

fn index(&self, key: &Q) -> &V

Performs the indexing (container[index]) operation.

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

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

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

The type of the elements being iterated over.

type IntoIter = Iter<'a, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

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

The type of the elements being iterated over.

type IntoIter = IterMut<'a, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

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

Tests for self and other values to be equal, and is used by ==.

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

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