Struct Document

pub struct Document<S> { /* private fields */ }

The root TOML Table, containing Key/Value pairs and all other logic Tables

Implementations

impl Document<&'static str>

pub fn new() -> Self

Creates an empty document

impl<S: AsRef<str>> Document<S>

pub fn parse(raw: S) -> Result<Self, TomlError>

Parse a TOML document

impl<S> Document<S>

pub fn as_item(&self) -> &Item

Returns a reference to the root item.

pub fn into_item(self) -> Item

Returns the root item.

pub fn as_table(&self) -> &Table

Returns a reference to the root table.

pub fn into_table(self) -> Table

Returns the root table.

pub fn iter(&self) -> Iter<'_>

Returns an iterator over the root table.

pub fn trailing(&self) -> &RawString

Whitespace after last element

impl<S: AsRef<str>> Document<S>

pub fn raw(&self) -> &str

Access the raw, unparsed document

impl<S: AsRef<str>> Document<S>

pub fn into_mut(self) -> DocumentMut

Allow editing of the DocumentMut

Methods from Deref<Target = Table>

pub fn get_values(&self) -> Vec<(Vec<&Key>, &Value)>

Get key/values for values that are visually children of this table

For example, this will return dotted keys

pub fn is_implicit(&self) -> bool

If a table has no key/value pairs and implicit, it will not be displayed.

pub fn is_dotted(&self) -> bool

Check if this is a wrapper for dotted keys, rather than a standard table

pub fn position(&self) -> Option<isize>

The position of the Table within the DocumentMut.

Returns None if the Table was created manually (i.e. not via parsing) in which case its position is set automatically. This can be overridden with Table::set_position.

pub fn decor(&self) -> &Decor

Returns the decor associated with a given key of the table.

pub fn key(&self, key: &str) -> Option<&Key>

Returns an accessor to a key’s formatting

pub fn span(&self) -> Option<Range<usize>>

The location within the original document

This generally requires a Document.

pub fn iter(&self) -> Iter<'_>

Returns an iterator over all key/value pairs, including empty.

pub fn len(&self) -> usize

Returns the number of non-empty items in the table.

pub fn is_empty(&self) -> bool

Returns true if the table is empty.

pub fn get<'a>(&'a self, key: &str) -> Option<&'a Item>

Returns an optional reference to an item given the key.

pub fn get_key_value<'a>(&'a self, key: &str) -> Option<(&'a Key, &'a Item)>

Return references to the key-value pair stored for key, if it is present, else None.

pub fn contains_key(&self, key: &str) -> bool

Returns true if the table contains an item with the given key.

pub fn contains_table(&self, key: &str) -> bool

Returns true if the table contains a table with the given key.

pub fn contains_value(&self, key: &str) -> bool

Returns true if the table contains a value with the given key.

pub fn contains_array_of_tables(&self, key: &str) -> bool

Returns true if the table contains an array of tables with the given key.

Trait Implementations

impl<S: Clone> Clone for Document<S>

fn clone(&self) -> Document<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Document<S>

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

Formats the value using the given formatter.

impl Default for Document<&'static str>

fn default() -> Self

Returns the “default value” for a type.

impl<S> Deref for Document<S>

type Target = Table

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl FromStr for Document<String>

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

Parses a document from a &str

type Err = TomlError

The associated error which can be returned from parsing.