Struct toml_edit::Table

pub struct Table { /* private fields */ }

Type representing a TOML non-inline table

Implementations

impl Table

Constructors

See also FromIterator

pub fn new() -> Self

Creates an empty table.

pub fn into_inline_table(self) -> InlineTable

Convert to an inline table

impl Table

Formatting

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.

impl 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 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 Table

fn clone(&self) -> Table

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Table

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

Formats the value using the given formatter.

impl Default for Table

fn default() -> Table

Returns the “default value” for a type.

impl Display for Table

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

Formats the value using the given formatter.

impl<K: Into<Key>, V: Into<Item>> Extend<(K, V)> for Table

fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<Table> for ArrayOfTables

fn extend<T: IntoIterator<Item = Table>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Table> for DocumentMut

fn from(root: Table) -> Self

Converts to this type from the input type.

impl<K: Into<Key>, V: Into<Item>> FromIterator<(K, V)> for Table

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator.

impl FromIterator<Table> for ArrayOfTables

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = Table>,

Creates a value from an iterator.

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

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 Table

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

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

impl<'s> IntoIterator for &'s Table

type Item = (&'s str, &'s Item)

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = (&'s str, &'s Item)> + 's>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Table

type Item = (InternalString, Item)

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = (InternalString, Item)>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl TableLike for Table

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

Returns an iterator over key/value pairs.

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

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

fn clear(&mut self)

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

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

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

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.

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

Returns an optional reference to an item given the key.

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

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

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.

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.

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

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

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

Inserts a key-value pair into the map.

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

Removes an item given the key.

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

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

fn fmt(&mut self)

Auto formats the table.

fn sort_values(&mut self)

Sorts Key/Value Pairs of the table.

fn is_dotted(&self) -> bool

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

fn set_dotted(&mut self, yes: bool)

Change this table’s dotted status

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

Returns an accessor to a key’s formatting

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

Returns an accessor to a key’s formatting

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.

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.

fn len(&self) -> usize

Returns the number of nonempty items.

fn is_empty(&self) -> bool

Returns true if the table is empty.