toml::map

Struct Map

pub struct Map<K, V> { /* private fields */ }

Expand description

Represents a TOML key/value type.

Implementations§

Source §

impl Map<String, Value>

Source

pub fn new() -> Self

Makes a new empty Map.

Source

pub fn with_capacity(capacity: usize) -> Self

Makes a new empty Map with the given initial capacity.

Source

pub fn clear(&mut self)

Clears the map, removing all values.

Source

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

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.

Source

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

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.

Source

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

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.

Source

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.

Source

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

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.

Source

pub fn retain<F>(&mut self, keep: F)
where F: FnMut(&str, &mut Value) -> bool,

Retains only the elements specified by the keep predicate.

In other words, remove all pairs (k, v) for which keep(&k, &mut v) returns false.

The elements are visited in iteration order.

Source

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.

Source

pub fn len(&self) -> usize

Returns the number of elements in the map.

Source

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

Source

pub fn iter(&self) -> Iter<'_> ⓘ

Gets an iterator over the entries of the map.

Source

pub fn iter_mut(&mut self) -> IterMut<'_> ⓘ

Gets a mutable iterator over the entries of the map.

Source

pub fn keys(&self) -> Keys<'_> ⓘ

Gets an iterator over the keys of the map.

Source

pub fn values(&self) -> Values<'_> ⓘ

Gets an iterator over the values of the map.

Source §

impl Map<String, Value>

Source

pub fn try_from<T>(value: T) -> Result<Self, Error>
where T: Serialize,

Convert a T into toml::Table.

This conversion can fail if T’s implementation of Serialize decides to fail, or if T contains a map with non-string keys.

Source

pub fn try_into<'de, T>(self) -> Result<T, Error>
where T: Deserialize<'de>,

Interpret a toml::Table as an instance of type T.

This conversion can fail if the structure of the Table does not match the structure expected by T, for example if T is a bool which can’t be mapped to a Table. It can also fail if the structure is correct but T’s implementation of Deserialize decides that something is wrong with the data, for example required struct fields are missing from the TOML map or some number is too big to fit in the expected primitive type.