Struct toml_spanned_value::spanned_value::Map

pub struct Map<K: Ord + Hash, V> { /* fields omitted */ }

Represents a JSON key/value type.

Methods

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

pub fn new() -> Self

Makes a new empty Map.

pub fn with_capacity(capacity: usize) -> Self

Makes a new empty Map with the given initial capacity.

pub fn clear(&mut self)

Clears the map, removing all values.

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

Returns a reference to the value corresponding to the key.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

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

Returns true if the map contains a value for the specified key.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

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

Returns a mutable reference to the value corresponding to the key.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

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

Inserts a key-value pair into the map.

If the map did not have this key present, None is returned.

If the map did have this key present, the value is updated, and the old value is returned. The key is not updated, though; this matters for types that can be == without being identical.

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

Removes a key from the map, returning the value at the key if the key was previously in the map.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn entry<S>(&mut self, key: S) -> Entry<K, V> where
    S: Into<K>, 

Gets the given key's corresponding entry in the map for in-place manipulation.

pub fn len(&self) -> usize

Returns the number of elements in the map.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

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

Gets an iterator over the entries of the map.

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

Gets a mutable iterator over the entries of the map.

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

Gets an iterator over the keys of the map.

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

Gets an iterator over the values of the map.

Trait Implementations

impl From<Map<Spanned<String>, Spanned<ValueKind>>> for ValueKind

fn from(val: Table) -> ValueKind

Performs the conversion.

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

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

Extends a collection with the contents of an iterator.

impl<'a, K: Ord + Hash, 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: Ord + Hash, 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: Ord + Hash, 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<K: Clone + Ord + Hash, V: Clone> Clone for Map<K, V>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Ord + Hash, V> Default for Map<K, V>

fn default() -> Self

Returns the "default value" for a type.

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

fn eq(&self, other: &Map<K, V>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Map<K, V>) -> bool

This method tests for !=.

impl<K: Ord + Hash + Debug, V: Debug> Debug for Map<K, V>

fn fmt(&self, formatter: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

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

Access an element of this map. Panics if the given key is not present in the map.

type Output = V

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a, K, V, Q: ?Sized> IndexMut<&'a Q> for Map<K, V> where
    K: Ord + Hash + Borrow<Q>,
    Q: Ord + Eq + Hash, 

Mutably access an element of this map. Panics if the given key is not present in the map.

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

Performs the mutable indexing (container[index]) operation.

impl<K: Ord + Hash, V> StructuralPartialEq for Map<K, V>

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

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

Creates a value from an iterator.

impl<K: Ord + Hash + Serialize, V: Serialize> Serialize for Map<K, V>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de, K, V> Deserialize<'de> for Map<K, V> where
    K: Ord + Hash + Deserialize<'de>,
    V: Deserialize<'de>, 

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.