Struct toml_edit::InlineTable

pub struct InlineTable { /* private fields */ }

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

Implementations

impl InlineTable

Constructors

See also FromIterator

pub fn new() -> Self

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 the key/value pairs by key.

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

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_decor_mut(&mut self, key: &str) -> Option<&mut Decor>

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

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

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

impl InlineTable

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

Returns an iterator over key/value pairs.

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

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 iff 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) -> InlineEntry<'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) -> 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 iff the table contains given key.

pub fn get_or_insert<V: Into<Value>>(
    &mut self,
    key: &str,
    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.

pub fn insert(&mut self, key: &str, 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.

Trait Implementations

impl Clone for InlineTable

fn clone(&self) -> InlineTable

Returns a copy 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

Formats the value using the given formatter.

impl Default for InlineTable

fn default() -> InlineTable

Returns the “default value” for a type.

impl<'de, 'a> Deserializer<'de> for InlineTable

type Error = Error

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

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an optional value.

fn deserialize_newtype_struct<V>(
    self,
    _name: &'static str,
    visitor: V
) -> Result<V::Value, Error> where
    V: Visitor<'de>, 

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

fn deserialize_struct<V>(
    self,
    _name: &'static str,
    _fields: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Error> where
    V: Visitor<'de>, 

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

fn deserialize_enum<V>(
    self,
    _name: &'static str,
    _variants: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Error> where
    V: Visitor<'de>, 

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

fn deserialize_bool<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a bool value.

fn deserialize_u8<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_i8<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_f32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_char<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a char value.

fn deserialize_str<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

fn deserialize_string<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

fn deserialize_byte_buf<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a unit value.

fn deserialize_ignored_any<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

fn deserialize_unit_struct<V>(
    self,
    name: &'static str,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

fn deserialize_tuple_struct<V>(
    self,
    name: &'static str,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

fn deserialize_tuple<V>(
    self,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

fn deserialize_identifier<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

fn deserialize_i128<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u128<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an u128 value.

fn is_human_readable(&self) -> bool

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

impl Display for InlineTable

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

Formats the value using the given formatter.

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

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

fn from(table: InlineTable) -> Self

Converts to this type from the input type.

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

fn from_iter<I>(iter: I) -> Self 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<'de> IntoDeserializer<'de, Error> for InlineTable

type Deserializer = InlineTable

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self

Convert this value into a deserializer.

impl IntoIterator for InlineTable

type Item = (InternalString, Value)

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = (InternalString, Value)> + 'static, Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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, Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl TableLike for InlineTable

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 iff 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_decor_mut(&mut self, key: &str) -> Option<&mut Decor>

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

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

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 iff the table is empty.