Struct Mapping 

pub(crate) struct Mapping {
    shape: Shape,
    entries: Vec<Entry>,
    indent: usize,
    step: usize,
}

A mapping whose entries can be listed, replaced, appended, and removed.

Fields

shape: Shape

entries: Vec<Entry>

indent: usize

step: usize

Implementations

impl Mapping

pub(super) const fn block( opening: Text, entries: Vec<Entry>, indent: usize, step: usize, ) -> Self

A block mapping whose keys sit at indent, with nested mappings step columns deeper.

pub(super) const fn empty_flow( before: Text, braces: Text, after: Text, indent: usize, step: usize, ) -> Self

An empty flow mapping whose block entries will sit at indent.

pub(super) fn reopened(self, opening: Text, indent: usize, step: usize) -> Self

This mapping opened by opening, with its keys moved to indent and nested mappings step columns deeper.

pub(super) fn take_header(&mut self) -> Text

Split off the leading text of the first entry, except for the comment block directly above its key.

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

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

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

pub(crate) fn insert(&mut self, entry: Entry)

Put entry in the mapping, laid out at this mapping’s indent and step.

An entry with the same key is replaced in place. It keeps the existing key text, trailing comment of a plain value, and leading text unless the new entry brings a comment. Any other entry is appended.

pub(crate) fn remove(&mut self, key: &str)

Remove the entry with key, together with its leading text. A mapping left without entries becomes {}.

pub(super) fn comment(&self) -> Option<&str>

The comment on the key line, with the whitespace before it.

pub(super) fn keep_comment(&mut self, comment: &str)

Put comment on the key line unless it has one.

const fn key_line(&self) -> &Text

What follows the owning key on its line.

const fn key_line_mut(&mut self) -> &mut Text

pub(super) fn collapse(&mut self)

Turn an emptied block mapping into {}, as an empty value would read back as null. Anchors and a trailing comment stay.

fn reindent_to(&mut self, indent: usize, step: usize)

Move the keys to indent and nested mappings to step columns per level, carrying every entry’s lines along.

pub(super) fn terminate(&mut self)

Make the last line of the mapping end with a line break.

fn expand(&mut self)

Turn an empty flow mapping into a block mapping, keeping what surrounds it.

The line holding the braces stays when something else is on it, such as a key or a --- marker. A bare {} line disappears. A comment after the closing brace moves up to the key’s line.

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

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

Formats the value using the given formatter.

impl Eq for Mapping

impl PartialEq for Mapping

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Mapping