pub struct Map<K, V> { /* private fields */ }
Expand description
Represents a TOML key/value type.
Implementations
sourceimpl Map<String, Value>
impl Map<String, Value>
sourcepub fn with_capacity(capacity: usize) -> Map<String, Value>
pub fn with_capacity(capacity: usize) -> Map<String, Value>
Makes a new empty Map with the given initial capacity.
sourcepub fn get<Q>(&self, key: &Q) -> Option<&Value>where
Q: Ord + Eq + Hash + ?Sized,
String: Borrow<Q>,
pub fn get<Q>(&self, key: &Q) -> Option<&Value>where
Q: Ord + Eq + Hash + ?Sized,
String: Borrow<Q>,
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.
sourcepub fn contains_key<Q>(&self, key: &Q) -> boolwhere
Q: Ord + Eq + Hash + ?Sized,
String: Borrow<Q>,
pub fn contains_key<Q>(&self, key: &Q) -> boolwhere
Q: Ord + Eq + Hash + ?Sized,
String: Borrow<Q>,
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.
sourcepub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut Value>where
Q: Ord + Eq + Hash + ?Sized,
String: Borrow<Q>,
pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut Value>where
Q: Ord + Eq + Hash + ?Sized,
String: Borrow<Q>,
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.
sourcepub fn insert(&mut self, k: String, v: Value) -> Option<Value>
pub fn insert(&mut self, k: String, v: Value) -> Option<Value>
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.
sourcepub fn remove<Q>(&mut self, key: &Q) -> Option<Value>where
Q: Ord + Eq + Hash + ?Sized,
String: Borrow<Q>,
pub fn remove<Q>(&mut self, key: &Q) -> Option<Value>where
Q: Ord + Eq + Hash + ?Sized,
String: Borrow<Q>,
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.
sourcepub fn entry<S>(&mut self, key: S) -> Entry<'_>where
S: Into<String>,
pub fn entry<S>(&mut self, key: S) -> Entry<'_>where
S: Into<String>,
Gets the given key’s corresponding entry in the map for in-place manipulation.
sourcepub fn iter(&self) -> Iter<'_>ⓘNotable traits for Iter<'a>impl<'a> Iterator for Iter<'a> type Item = (&'a String, &'a Value);
pub fn iter(&self) -> Iter<'_>ⓘNotable traits for Iter<'a>impl<'a> Iterator for Iter<'a> type Item = (&'a String, &'a Value);
Gets an iterator over the entries of the map.
sourcepub fn iter_mut(&mut self) -> IterMut<'_>ⓘNotable traits for IterMut<'a>impl<'a> Iterator for IterMut<'a> type Item = (&'a String, &'a mut Value);
pub fn iter_mut(&mut self) -> IterMut<'_>ⓘNotable traits for IterMut<'a>impl<'a> Iterator for IterMut<'a> type Item = (&'a String, &'a mut Value);
Gets a mutable iterator over the entries of the map.
Trait Implementations
sourceimpl<'de> Deserialize<'de> for Map<String, Value>
impl<'de> Deserialize<'de> for Map<String, Value>
sourcefn deserialize<D>(
deserializer: D
) -> Result<Map<String, Value>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D
) -> Result<Map<String, Value>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Extend<(String, Value)> for Map<String, Value>
impl Extend<(String, Value)> for Map<String, Value>
sourcefn extend<T>(&mut self, iter: T)where
T: IntoIterator<Item = (String, Value)>,
fn extend<T>(&mut self, iter: T)where
T: IntoIterator<Item = (String, Value)>,
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl<'a, Q> Index<&'a Q> for Map<String, Value>where
Q: Ord + Eq + Hash + ?Sized,
String: Borrow<Q>,
impl<'a, Q> Index<&'a Q> for Map<String, Value>where
Q: Ord + Eq + Hash + ?Sized,
String: Borrow<Q>,
Access an element of this map. Panics if the given key is not present in the map.
sourceimpl<'a, Q> IndexMut<&'a Q> for Map<String, Value>where
Q: Ord + Eq + Hash + ?Sized,
String: Borrow<Q>,
impl<'a, Q> IndexMut<&'a Q> for Map<String, Value>where
Q: Ord + Eq + Hash + ?Sized,
String: Borrow<Q>,
Mutably access an element of this map. Panics if the given key is not present in the map.
sourceimpl<'a> IntoIterator for &'a Map<String, Value>
impl<'a> IntoIterator for &'a Map<String, Value>
sourceimpl<'a> IntoIterator for &'a mut Map<String, Value>
impl<'a> IntoIterator for &'a mut Map<String, Value>
sourceimpl IntoIterator for Map<String, Value>
impl IntoIterator for Map<String, Value>
sourceimpl PartialEq<Map<String, Value>> for Map<String, Value>
impl PartialEq<Map<String, Value>> for Map<String, Value>
sourceimpl Serialize for Map<String, Value>
impl Serialize for Map<String, Value>
sourcefn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
Serialize this value into the given Serde serializer. Read more
Auto Trait Implementations
impl<K, V> RefUnwindSafe for Map<K, V>where
K: RefUnwindSafe,
V: RefUnwindSafe,
impl<K, V> Send for Map<K, V>where
K: Send,
V: Send,
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>where
K: RefUnwindSafe,
V: RefUnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
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