Struct Mapping 

pub struct Mapping { /* private fields */ }

An ordered YAML mapping (preserves insertion / source order, like the reference implementation which dumps with sort_keys=False).

Keys are Values for generality, but OKF frontmatter keys are always strings; the get / insert helpers operate on string keys for convenience.

Implementations

impl Mapping

pub const fn new() -> Self

Creates an empty mapping.

pub const fn len(&self) -> usize

Number of key/value pairs.

pub const fn is_empty(&self) -> bool

Returns true if the mapping has no entries.

pub fn get(&self, key: &str) -> Option<&Value>

Looks up a value by string key.

pub fn get_mut(&mut self, key: &str) -> Option<&mut Value>

Looks up a mutable value by string key.

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

Returns true if the mapping contains the given string key.

pub fn insert(&mut self, key: impl Into<String>, value: Value) -> Option<Value>

Inserts (or, if the string key already exists, replaces) a value, preserving the position of an existing key. Returns the previous value.

pub fn remove(&mut self, key: &str) -> Option<Value>

Removes a value by string key, preserving order of the rest.

pub fn iter(&self) -> impl Iterator<Item = (&Value, &Value)>

Iterates over (key, value) pairs in order.

pub fn iter_mut(&mut self) -> impl Iterator<Item = (&mut Value, &mut Value)>

Iterates over mutable (key, value) pairs in order.

pub fn keys(&self) -> impl Iterator<Item = &str>

Iterates over string keys (skipping any non-string keys).

pub fn values(&self) -> impl Iterator<Item = &Value>

Iterates over values in order.

pub fn entries(&self) -> &[(Value, Value)]

Borrows the underlying slice of key-value entry pairs.

Trait Implementations

impl Clone for Mapping

fn clone(&self) -> Mapping

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mapping

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

Formats the value using the given formatter.

impl Default for Mapping

fn default() -> Mapping

Returns the “default value” for a type.

impl Display for Mapping

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

Formats the value using the given formatter.

impl<'a> Extend<(&'a str, Value)> for Mapping

fn extend<T: IntoIterator<Item = (&'a str, Value)>>(&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 Extend<(String, Value)> for Mapping

fn extend<T: IntoIterator<Item = (String, Value)>>(&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 Extend<(Value, Value)> for Mapping

fn extend<T: IntoIterator<Item = (Value, Value)>>(&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 From<Frontmatter> for Mapping

fn from(fm: Frontmatter) -> Self

Converts to this type from the input type.

impl From<Mapping> for Frontmatter

fn from(map: Mapping) -> Self

Converts to this type from the input type.

impl From<Mapping> for Value

fn from(m: Mapping) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<(&'a str, Value)> for Mapping

fn from_iter<T: IntoIterator<Item = (&'a str, Value)>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<(String, Value)> for Mapping

fn from_iter<T: IntoIterator<Item = (String, Value)>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<(Value, Value)> for Mapping

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

Creates a value from an iterator.

impl IntoIterator for Mapping

type Item = (Value, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter<(Value, Value)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a Mapping

type Item = (&'a Value, &'a Value)

The type of the elements being iterated over.

type IntoIter = Map<Iter<'a, (Value, Value)>, fn(&(Value, Value)) -> (&Value, &Value)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Mapping

type Item = (&'a mut Value, &'a mut Value)

The type of the elements being iterated over.

type IntoIter = Map<IterMut<'a, (Value, Value)>, fn(&mut (Value, Value)) -> (&mut Value, &mut Value)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Mapping

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Mapping