Struct Tree 

pub(crate) struct Tree {
    header: Text,
    root: Entry,
    footer: Text,
}

A parsed YAML document.

Block mappings are split into entries. A flow mapping with entries is kept as raw text until an edit enters it, and then it prints in block style. Everything else is kept as raw text. Printing the tree gives the source back, with edits applied.

Fields

header: Text

root: Entry

footer: Text

Implementations

impl Tree

pub(crate) fn parse(text: &str) -> Result<Self, DocumentError>

Read a YAML document with a single document in it.

Errors

Returns an error when the text is not valid YAML or holds more than one document.

pub(super) fn new(header: Text, root: Value, footer: Text) -> Self

pub(crate) fn is_opaque_at(&self, path: &KeyPath) -> bool

Whether the node at path is a mapping the tree cannot edit.

pub(crate) fn collapse_empty_root(&mut self)

Print an empty root mapping as {}. Call after editing.

pub(super) fn into_mapping(self) -> Option<Mapping>

The root mapping, when the document has one the tree can edit.

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tree

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

Formats the value using the given formatter.

impl Display for Tree

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

Formats the value using the given formatter.

impl Editable for Tree

type Node = Entry

fn header_text(&self) -> &str

The text of the header comment of this document.

fn leading(&self) -> (&str, &str)

The text before the first entry as the document root holds it and as the first entry holds it. A format that keeps all of it in one place returns an empty root text.

fn set_leading(&mut self, applied: Applied<'_>)

Put the leading text of an applied header in place.

fn root(&self) -> &Entry

The root node.

fn root_mut(&mut self) -> &mut Entry

The root node the merge works on.

fn apply_header(&mut self, desired: &Self, existing: Existing)

Replace the leading comment block of this document with the header of desired.

impl Eq for Tree

impl PartialEq for Tree

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Tree