Struct TomlTree 

pub(crate) struct TomlTree(DocumentMut);

A TOML document that reconciliation edits in place.

Tuple Fields

0: DocumentMut

Implementations

impl TomlTree

pub(super) fn new() -> Self

pub(super) fn parse(source: &str) -> Result<Self, TomlError>

Parse TOML source.

Errors

Returns the parse error.

pub(super) fn table_mut(&mut self) -> &mut Table

pub(super) fn set_header(&mut self, text: String)

Set the header comment, which must end with a line break.

pub(super) fn align_with(&mut self, desired: &Self, existing: Existing)

Carry over the comments and the generated header of desired, and give every table an explicit position.

Without explicit positions a new subtable takes its place from its neighbours on the first run and from its position on the next, so reconciliation would need two runs to converge.

fn root_prefix(&self) -> Option<&str>

fn first_prefix(&self) -> &str

The decor text before the first entry. A parsed document keeps its leading comments on the first entry, not on the root table.

fn set_first_prefix(&mut self, text: String)

Trait Implementations

impl Clone for TomlTree

fn clone(&self) -> TomlTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TomlTree

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

Formats the value using the given formatter.

impl Display for TomlTree

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

Formats the value using the given formatter.

impl Editable for TomlTree

type Node = Item

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) -> &Item

The root node.

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

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.