Struct toml_edit::DocumentMut

pub struct DocumentMut { /* private fields */ }

Type representing a TOML document

Implementations

impl DocumentMut

pub fn new() -> Self

Creates an empty document

pub fn as_item(&self) -> &Item

Returns a reference to the root item.

pub fn as_item_mut(&mut self) -> &mut Item

Returns a mutable reference to the root item.

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: impl Into<RawString>)

Set whitespace after last element

pub fn trailing(&self) -> &RawString

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 sort_values_by<F>(&mut self, compare: F)

where F: FnMut(&Key, &Item, &Key, &Item) -> Ordering,

Sort Key/Value Pairs of the table using the using the comparison function compare.

The comparison function receives two key and value pairs to compare (you can sort by keys or values or their combination as needed).

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::DocumentMut;
let mut doc = "[a]\n[a.b]\n".parse::<DocumentMut>().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, doc_position: usize)

Sets the position of the Table within the DocumentMut.

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

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_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(&self, key: &str) -> Option<&Key>

Returns an accessor to a key’s formatting

pub fn key_mut(&mut self, key: &str) -> Option<KeyMut<'_>>

Returns an accessor to a key’s formatting

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

👎Deprecated since 0.21.1: Replaced with key_mut

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

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

👎Deprecated since 0.21.1: Replaced with key_mut

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

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

The location within the original document

This generally requires an ImDocument.

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 if 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 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 get_key_value_mut<'a>( &'a mut self, key: &str, ) -> Option<(KeyMut<'a>, &'a mut Item)>

Return mutable 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.

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.

pub fn retain<F>(&mut self, keep: F)

where F: FnMut(&str, &mut Item) -> bool,

Retains only the elements specified by the keep predicate.

In other words, remove all pairs (key, item) for which keep(&key, &mut item) returns false.

The elements are visited in iteration order.

Trait Implementations

impl Clone for DocumentMut

fn clone(&self) -> DocumentMut

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentMut

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

Formats the value using the given formatter.

impl Default for DocumentMut

fn default() -> Self

Returns the “default value” for a type.

impl Deref for DocumentMut

type Target = Table

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for DocumentMut

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

Mutably dereferences the value.

impl Display for DocumentMut

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

Formats the value using the given formatter.

impl From<DocumentMut> for Deserializer

fn from(doc: DocumentMut) -> Self

Converts to this type from the input type.

impl From<Table> for DocumentMut

fn from(root: Table) -> Self

Converts to this type from the input type.

impl FromStr for DocumentMut

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 DocumentMut

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 DocumentMut

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

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

impl<'de> IntoDeserializer<'de, Error> for DocumentMut

type Deserializer = Deserializer

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.