Struct toml_edit::Document

pub struct Document {
    pub root: Item,
    // some fields omitted
}

Type representing a TOML document

Fields

root: Item

Root should always be Item::Table.

Methods

impl Document

pub fn to_string_in_original_order(&self) -> String

Returns a string representation of the TOML document, attempting to keep the table headers in their original order.

impl Document

pub fn new() -> Self

Creates an empty document

pub fn as_table(&self) -> &Table

Returns a reference to the root table.

pub fn as_table_mut(&mut self) -> &mut Table

Returns a mutable reference to the root table.

pub fn iter(&self) -> Iter

Returns an iterator over the root table.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the "default value" for a type.

impl Display for Document

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

Formats the value using the given formatter.

impl FromStr for Document

type Err = TomlError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a document from a &str

impl<'s> Index<&'s str> for Document

type Output = Item

The returned type after indexing.

fn index(&self, key: &'s str) -> &Item

Performs the indexing (container[index]) operation.

impl<'s> IndexMut<&'s str> for Document

fn index_mut(&mut self, key: &'s str) -> &mut Item

Performs the mutable indexing (container[index]) operation.