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 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 keys(&self) -> impl Iterator<Item = &str>

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

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 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 PartialEq for Mapping

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Mapping