pub struct Document { /* private fields */ }
Expand description

Type representing a TOML document

Implementations

Creates an empty document

Returns a reference to the root item.

Returns a mutable reference to the root item.

Returns a reference to the root table.

Returns a mutable reference to the root table.

Returns an iterator over the root table.

Set whitespace after last element

Whitespace after last element

Methods from Deref<Target = Table>

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

For example, this will return dotted keys

Auto formats the table.

Sorts Key/Value Pairs of the table.

Doesn’t affect subtables or subarrays.

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).

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");

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

Change this table’s dotted status

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

Sets the position of the Table within the Document.

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. This can be overridden with Table::set_position.

Returns the surrounding whitespace

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

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

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

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

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

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

Returns true iff the table is empty.

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

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

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

Returns an optional reference to an item given the key.

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

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

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

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

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

Inserts a key-value pair into the map.

Inserts a key-value pair into the map.

Removes an item given the key.

source

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

The resulting type after dereferencing.

Dereferences the value.

Mutably dereferences the value.

The error type that can be returned if some error occurs during deserialization. Read more

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input. Read more

Hint that the Deserialize type is expecting an optional value. Read more

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants. Read more

Hint that the Deserialize type is expecting a bool value.

Hint that the Deserialize type is expecting a u8 value.

Hint that the Deserialize type is expecting a u16 value.

Hint that the Deserialize type is expecting a u32 value.

Hint that the Deserialize type is expecting a u64 value.

Hint that the Deserialize type is expecting an i8 value.

Hint that the Deserialize type is expecting an i16 value.

Hint that the Deserialize type is expecting an i32 value.

Hint that the Deserialize type is expecting an i64 value.

Hint that the Deserialize type is expecting a f32 value.

Hint that the Deserialize type is expecting a f64 value.

Hint that the Deserialize type is expecting a char value.

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer. Read more

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer. Read more

Hint that the Deserialize type is expecting a sequence of values.

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer. Read more

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer. Read more

Hint that the Deserialize type is expecting a map of key-value pairs.

Hint that the Deserialize type is expecting a unit value.

Hint that the Deserialize type is expecting a newtype struct with a particular name. Read more

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored. Read more

Hint that the Deserialize type is expecting a unit struct with a particular name. Read more

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields. Read more

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data. Read more

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant. Read more

Hint that the Deserialize type is expecting a struct with a particular name and fields. Read more

Hint that the Deserialize type is expecting an i128 value. Read more

Hint that the Deserialize type is expecting an u128 value. Read more

Determine whether Deserialize implementations should expect to deserialize their human-readable form. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Parses a document from a &str

The associated error which can be returned from parsing.

The returned type after indexing.

Performs the indexing (container[index]) operation. Read more

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

The type of the deserializer being converted into.

Convert this value into a deserializer.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

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

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.