Struct toml_edit::InlineTable

source ·
pub struct InlineTable { /* private fields */ }
Expand description

Type representing a TOML inline table, payload of the Value::InlineTable variant

Implementations§

source§

impl InlineTable

Constructors

See also FromIterator

source

pub fn new() -> Self

Creates an empty table.

source

pub fn into_table(self) -> Table

Convert to a table

source§

impl InlineTable

Formatting

source

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

source

pub fn fmt(&mut self)

Auto formats the table.

source

pub fn sort_values(&mut self)

Sorts the key/value pairs by key.

source

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

source

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

Change this table’s dotted status

source

pub fn is_dotted(&self) -> bool

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

source

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

Returns the surrounding whitespace

source

pub fn decor(&self) -> &Decor

Returns the surrounding whitespace

source

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

Returns an accessor to a key’s formatting

source

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

Returns an accessor to a key’s formatting

source

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.

source

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.

source

pub fn set_preamble(&mut self, preamble: impl Into<RawString>)

Set whitespace after before element

source

pub fn preamble(&self) -> &RawString

Whitespace after before element

source

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

The location within the original document

This generally requires an ImDocument.

source§

impl InlineTable

source

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

Returns an iterator over key/value pairs.

source

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

Returns an iterator over key/value pairs.

source

pub fn len(&self) -> usize

Returns the number of key/value pairs.

source

pub fn is_empty(&self) -> bool

Returns true if the table is empty.

source

pub fn clear(&mut self)

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

source

pub fn entry(&mut self, key: impl Into<InternalString>) -> InlineEntry<'_>

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

source

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.

source

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

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

source

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

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

source

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.

source

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.

source

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

Returns true if the table contains given key.

source

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

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

source

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

Inserts a key-value pair into the map.

source

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

Inserts a key-value pair into the map.

source

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

Removes an item given the key.

source

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.

source

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§

source§

impl Clone for InlineTable

source§

fn clone(&self) -> InlineTable

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for InlineTable

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for InlineTable

source§

fn default() -> InlineTable

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

impl Display for InlineTable

source§

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

Formats the value using the given formatter. Read more
source§

impl<K: Into<Key>, V: Into<Value>> Extend<(K, V)> for InlineTable

source§

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

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

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. Read more
source§

impl From<InlineTable> for Value

source§

fn from(table: InlineTable) -> Self

Converts to this type from the input type.
source§

impl<K: Into<Key>, V: Into<Value>> FromIterator<(K, V)> for InlineTable

source§

fn from_iter<I>(iter: I) -> Self
where I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator. Read more
source§

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

§

type Output = Value

The returned type after indexing.
source§

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

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

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

source§

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

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

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?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl IntoIterator for InlineTable

§

type Item = (InternalString, Value)

The type of the elements being iterated over.
§

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

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl TableLike for InlineTable

source§

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

Returns an iterator over key/value pairs.
source§

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

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

fn clear(&mut self)

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

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

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

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.
source§

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

Returns an optional reference to an item given the key.
source§

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

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

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.
source§

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.
source§

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

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

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

Inserts a key-value pair into the map.
source§

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

Removes an item given the key.
source§

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

Get key/values for values that are visually children of this table Read more
source§

fn fmt(&mut self)

Auto formats the table.
source§

fn sort_values(&mut self)

Sorts Key/Value Pairs of the table. Read more
source§

fn set_dotted(&mut self, yes: bool)

Change this table’s dotted status
source§

fn is_dotted(&self) -> bool

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

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

Returns an accessor to a key’s formatting
source§

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

Returns an accessor to a key’s formatting
source§

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.
source§

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.
source§

fn len(&self) -> usize

Returns the number of nonempty items.
source§

fn is_empty(&self) -> bool

Returns true if the table is empty.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.