Struct Toml 

pub(crate) struct Toml {
    pub(super) inline_width: InlineWidth,
    format: Format,
}

Reconciles TOML documents, rendering inline tables up to a fixed width.

Fields

inline_width: InlineWidth

format: Format

Implementations

impl Toml

pub(crate) const fn new(inline_width: InlineWidth) -> Self

pub(super) const fn unsupported(self, feature: Feature) -> DocumentError

impl Toml

fn key_comment(parent: &Item, key: &str) -> Option<String>

The comment above the value key key of parent, if it has one.

fn set_key_comment( table: &mut dyn TableLike, key: &str, comment: Option<String>, )

fn trim_leading_blank_lines(table: &mut Table)

Drop the blank lines before the first entry of table, which only separated it from an entry that is gone.

fn replace_keeping_decor(old: &Item, new: Item) -> Item

new, with the decor of the item it replaces so that the user’s spacing and comments stay. A table keeps the comment above its header unless the new table brings one, and then keeps the blank lines above the old one.

impl Toml

pub(super) fn build_document( self, annotated: &Annotated, ) -> Result<TomlTree, DocumentError>

fn populate_table( self, table: &mut Table, entries: &Entries, is_root: bool, ) -> Result<(), DocumentError>

fn has_header(item: &Item) -> bool

Whether item is printed under a header of its own.

fn item( self, key: &str, annotated: &Annotated, is_root: bool, ) -> Result<Item, DocumentError>

fn fits_inline(self, key: &str, inline: &InlineTable) -> bool

Whether key = inline fits within the configured columns.

fn array_item(self, items: &[Annotated]) -> Result<Item, DocumentError>

fn array(self, items: &[Annotated]) -> Result<Array, DocumentError>

fn spread(array: &mut Array, items: &[Annotated])

Put every item on its own line, with its comment above it.

fn inline_value(self, annotated: &Annotated) -> Result<TomlValue, DocumentError>

A value inside an inline table, which cannot hold comments.

fn array_value(self, annotated: &Annotated) -> Result<TomlValue, DocumentError>

fn scalar(self, scalar: &Scalar) -> Result<TomlValue, DocumentError>

const fn unvalidated(feature: Feature) -> DocumentError

fn styled_string( self, text: &str, style: StringStyle, ) -> Result<TomlValue, DocumentError>

fn literal_string(self, text: &str) -> Result<TomlValue, DocumentError>

fn inline_table(self, entries: &Entries) -> Result<InlineTable, DocumentError>

fn write_comment(out: &mut String, comment: &Comment, indent: &str)

fn comment_first_leaf(table: &mut Table, prefix: String)

Put prefix before the first line of a dotted table, which prints the decor of its leaf keys.

fn attach_comment(table: &mut Table, key: &str, comment: &Comment)

Trait Implementations

impl Backend for Toml

type Document = TomlTree

fn parse(&self, source: &str) -> Result<TomlTree, DocumentError>

Parse an existing source document.

fn format(&self) -> Format

The format this backend reads and writes.

fn build(&self, desired: &Annotated) -> Result<TomlTree, DocumentError>

Build the desired document from its annotated value.

fn string_leaf(&self, node: &Item) -> Result<Option<String>, DocumentError>

The text of node when it is a string, None for any other kind of value.

fn finish(&self, current: &mut TomlTree, desired: &TomlTree, existing: Existing)

Adjust the merged document before it is rendered.

fn descend<'n>( &self, node: &'n <<Self as Backend>::Document as Editable>::Node, key: &str, _path: &[String], ) -> Result<Option<&'n <<Self as Backend>::Document as Editable>::Node>, DocumentError>

The child key of node, which sits at path. Backends fail here when a node on the way cannot be read through.

fn explain(&self, _current: &Self::Document, error: MergeError) -> DocumentError

The error for a merge that failed against current. Backends can name a cause more precisely than the generic conflict.

fn read_string( &self, source: &str, path: &[String], ) -> Result<Option<String>, DocumentError>

The string at path in source, or None when a key on the way is absent.

fn reconcile( &self, desired: &Annotated, source: &Source<'_>, ownership: &Ownership, ) -> Result<Vec<u8>, DocumentError>

Reconcile a desired value against the current source.

impl Clone for Toml

fn clone(&self) -> Toml

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Toml

impl Debug for Toml

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

Formats the value using the given formatter.