Struct toml_edit::Document

pub struct Document { /* fields omitted */ }

Type representing a TOML document

Implementations

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.

pub fn set_trailing(&mut self, trailing: &str)

Set whitespace after last element

pub fn trailing(&self) -> &str

Whitespace after last element

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 fmt(&mut self)

Auto formats the table.

pub fn sort_values(&mut self)

Sorts Key/Value Pairs of the table.

Doesn’t affect subtables or subarrays.

pub fn set_implicit(&mut self, implicit: bool)

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

Examples

[target."x86_64/windows.json".dependencies]

In the document above, tables target and target."x86_64/windows.json" are implicit.

use toml_edit::Document;
let mut doc = "[a]\n[a.b]\n".parse::<Document>().expect("invalid toml");

doc["a"].as_table_mut().unwrap().set_implicit(true);
assert_eq!(doc.to_string(), "[a.b]\n");

pub fn is_implicit(&self) -> bool

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

pub fn set_dotted(&mut self, yes: bool)

Change this table’s dotted status

pub fn is_dotted(&self) -> bool

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

pub fn set_position(&mut self, position: usize)

Sets the position of the Table within the Document.

Setting the position of a table will only affect output when Document::to_string_in_original_order is used.

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

The position of the Table within the Document.

Returns None if the Table was created manually (i.e. not via parsing) in which case its position is set automatically.

pub fn decor_mut(&mut self) -> &mut Decor

Returns the surrounding whitespace

pub fn decor(&self) -> &Decor

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

pub fn key_decor_mut(&mut self, key: &str) -> Option<&mut Decor>

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

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

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

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

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

pub fn iter_mut(&mut self) -> IterMut<'_>

Returns an mutable 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 iff the table is empty.

pub fn clear(&mut self)

Clears the table, removing all key-value pairs. Keeps the allocated memory for reuse.

pub fn entry<'a>(&'a mut self, key: &str) -> Entry<'a>

Gets the given key’s corresponding entry in the Table for in-place manipulation.

pub fn entry_format<'a>(&'a mut self, key: &Key) -> Entry<'a>

Gets the given key’s corresponding entry in the Table for in-place manipulation.

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

Returns an optional reference to an item given the key.

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

Returns an optional mutable reference to an item given the key.

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

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

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

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

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

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

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

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

pub fn insert(&mut self, key: &str, item: Item) -> Option<Item>

Inserts a key-value pair into the map.

pub fn insert_formatted(&mut self, key: &Key, item: Item) -> Option<Item>

Inserts a key-value pair into the map.

pub fn remove(&mut self, key: &str) -> Option<Item>

Removes an item given the key.

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

Removes a key from the map, returning the stored key and value if the key was previously in the map.

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 Deref for Document

type Target = Table

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Document

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for Document

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

Formats the value using the given formatter.

impl FromStr for Document

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.

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.