Enum Entry 

pub enum Entry<'a, K: AsYaml> {
    Occupied(OccupiedEntry<'a>),
    Vacant(VacantEntry<'a, K>),
}

A view into a single entry in a Mapping, which may either be vacant or occupied.

Obtained from Mapping::entry.

Variants

Occupied(OccupiedEntry<'a>)

The key is already present in the mapping.

Vacant(VacantEntry<'a, K>)

The key is not present in the mapping.

Implementations

impl<'a, K: AsYaml> Entry<'a, K>

pub fn or_insert(self, default: impl AsYaml) -> YamlNode

Ensure a value is in the entry by inserting default if vacant, and return the resulting value as a YamlNode.

pub fn or_insert_with<V, F>(self, default: F) -> YamlNode

where V: AsYaml, F: FnOnce() -> V,

Ensure a value is in the entry by inserting the result of default if vacant, and return the resulting value as a YamlNode.

default is only called if the entry is vacant.

pub fn or_insert_mapping(self) -> Mapping

Ensure the entry holds a Mapping and return it.

If the entry is vacant, an empty mapping is inserted. If the entry is occupied but the value is not a mapping, it is replaced with an empty mapping. Otherwise the existing nested mapping is returned unchanged.

pub fn or_insert_sequence(self) -> Sequence

Ensure the entry holds a Sequence and return it.

If the entry is vacant, an empty sequence is inserted. If the entry is occupied but the value is not a sequence, it is replaced with an empty sequence. Otherwise the existing nested sequence is returned unchanged.

pub fn and_modify<F>(self, f: F) -> Self

where F: FnOnce(&OccupiedEntry<'a>),

Provide in-place access to an occupied entry before any potential inserts.

The closure is only called if the entry is occupied. Returns self unchanged so calls can be chained with or_insert and friends.

The tree uses interior mutability, so the closure receives a shared reference; OccupiedEntry::set_value and friends still work through &self.

pub fn key(&self) -> Option<YamlNode>

Return the key that this entry refers to, as a YamlNode.

For an occupied entry this is the existing key node in the tree. For a vacant entry it is the key that would be inserted, rendered as a fresh scalar node.

Trait Implementations

impl<'a, K: Debug + AsYaml> Debug for Entry<'a, K>

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

Formats the value using the given formatter.