Struct InlineTable

pub struct InlineTable { /* private fields */ }

Available on crate feature dep_toml_edit only.

A TOML Value that contains a collection of Key/Value pairs

Implementations

impl InlineTable

Constructors

See also FromIterator

pub fn new() -> InlineTable

Creates an empty table.

pub fn into_table(self) -> Table

Convert to a table

impl InlineTable

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

This is not recursive.

pub fn sort_values_by<F>(&mut self, compare: F)

where F: FnMut(&Key, &Value, &Key, &Value) -> 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).

This is not recursive.

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

Returns the surrounding whitespace

pub fn decor(&self) -> &Decor

Returns the surrounding whitespace

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 set_preamble(&mut self, preamble: impl Into<RawString>)

Set whitespace after before element

pub fn preamble(&self) -> &RawString

Whitespace after before element

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

The location within the original document

This generally requires a Document.

impl InlineTable

pub fn iter(&self) -> Box<dyn Iterator<Item = (&str, &Value)> + '_>

Returns an iterator over key/value pairs.

pub fn iter_mut( &mut self, ) -> Box<dyn Iterator<Item = (KeyMut<'_>, &mut Value)> + '_>

Returns an iterator over key/value pairs.

pub fn len(&self) -> usize

Returns the number of key/value pairs.

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(&mut self, key: impl Into<String>) -> InlineEntry<'_>

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

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

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

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

Return an optional reference to the value at the given the key.

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

Return an optional mutable reference to the value at the 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 given key.

pub fn get_or_insert<V>( &mut self, key: impl Into<String>, value: V, ) -> &mut Value

where V: Into<Value>,

Inserts a key/value pair if the table does not contain the key. Returns a mutable reference to the corresponding value.

pub fn insert(&mut self, key: impl Into<String>, value: Value) -> Option<Value>

Inserts a key-value pair into the map.

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

Inserts a key-value pair into the map.

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

Removes an item given the key.

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

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 Value) -> bool,

Retains only the elements specified by the keep predicate.

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

The elements are visited in iteration order.

Trait Implementations

impl Clone for InlineTable

fn clone(&self) -> InlineTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InlineTable

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

Formats the value using the given formatter.

impl Default for InlineTable

fn default() -> InlineTable

Returns the “default value” for a type.

impl Display for InlineTable

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

Formats the value using the given formatter.

impl<K, V> Extend<(K, V)> for InlineTable

where K: Into<Key>, V: Into<Value>,

fn extend<T>(&mut self, iter: T)

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

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<InlineTable> for Value

fn from(table: InlineTable) -> Value

Converts to this type from the input type.

impl<K, V> FromIterator<(K, V)> for InlineTable

where K: Into<Key>, V: Into<Value>,

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

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

Creates a value from an iterator.

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

type Output = Value

The returned type after indexing.

fn index(&self, key: &'s str) -> &Value

Performs the indexing (container[index]) operation.

impl<'s> IndexMut<&'s str> for InlineTable

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

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

impl<'s> IntoIterator for &'s InlineTable

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

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'s InlineTable as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoIterator for InlineTable

type Item = (String, Value)

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <InlineTable as IntoIterator>::IntoIter

Creates an iterator from a value.

impl TableLike for InlineTable

fn iter(&self) -> Box<dyn Iterator<Item = (&str, &Item)> + '_>

Returns an iterator over key/value pairs.

fn iter_mut(&mut self) -> Box<dyn Iterator<Item = (KeyMut<'_>, &mut Item)> + '_>

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 set_dotted(&mut self, yes: bool)

Change this table’s dotted status

fn is_dotted(&self) -> bool

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

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 len(&self) -> usize

Returns the number of nonempty items.

fn is_empty(&self) -> bool

Returns true if the table is empty.