Enum Item

pub enum Item {
    None,
    Value(Value),
    Table(Table),
    ArrayOfTables(ArrayOfTables),
}

Type representing either a value, a table, an array of tables, or none.

Variants

None

Type representing none.

Value(Value)

Type representing value.

Table(Table)

Type representing table.

ArrayOfTables(ArrayOfTables)

Type representing array of tables.

Implementations

impl Item

pub fn or_insert(&mut self, item: Item) -> &mut Item

Sets self to the given item if self is none and returns a mutable reference to self.

impl Item

Downcasting

pub fn type_name(&self) -> &'static str

Text description of value type

pub fn get<I: Index>(&self, index: I) -> Option<&Item>

Index into a TOML array or map. A string index can be used to access a value in a map, and a usize index can be used to access an element of an array.

Returns None if:

• The type of self does not match the type of the index, for example if the index is a string and self is an array or a number.
• The given key does not exist in the map or the given index is not within the bounds of the array.

pub fn get_mut<I: Index>(&mut self, index: I) -> Option<&mut Item>

Mutably index into a TOML array or map. A string index can be used to access a value in a map, and a usize index can be used to access an element of an array.

Returns None if:

• The type of self does not match the type of the index, for example if the index is a string and self is an array or a number.
• The given key does not exist in the map or the given index is not within the bounds of the array.

pub fn as_value(&self) -> Option<&Value>

Casts self to value.

pub fn as_table(&self) -> Option<&Table>

Casts self to table.

pub fn as_array_of_tables(&self) -> Option<&ArrayOfTables>

Casts self to array of tables.

pub fn as_value_mut(&mut self) -> Option<&mut Value>

Casts self to mutable value.

pub fn as_table_mut(&mut self) -> Option<&mut Table>

Casts self to mutable table.

pub fn as_array_of_tables_mut(&mut self) -> Option<&mut ArrayOfTables>

Casts self to mutable array of tables.

pub fn into_value(self) -> Result<Value, Self>

Casts self to value.

pub fn make_value(&mut self)

In-place convert to a value

pub fn into_table(self) -> Result<Table, Self>

Casts self to table.

pub fn into_array_of_tables(self) -> Result<ArrayOfTables, Self>

Casts self to array of tables.

pub fn is_value(&self) -> bool

Returns true if self is a value.

pub fn is_table(&self) -> bool

Returns true if self is a table.

pub fn is_array_of_tables(&self) -> bool

Returns true if self is an array of tables.

pub fn is_none(&self) -> bool

Returns true if self is None.

pub fn as_integer(&self) -> Option<i64>

Casts self to integer.

pub fn is_integer(&self) -> bool

Returns true if self is an integer.

pub fn as_float(&self) -> Option<f64>

Casts self to float.

pub fn is_float(&self) -> bool

Returns true if self is a float.

pub fn as_bool(&self) -> Option<bool>

Casts self to boolean.

pub fn is_bool(&self) -> bool

Returns true if self is a boolean.

pub fn as_str(&self) -> Option<&str>

Casts self to str.

pub fn is_str(&self) -> bool

Returns true if self is a string.

pub fn as_datetime(&self) -> Option<&Datetime>

Casts self to date-time.

pub fn is_datetime(&self) -> bool

Returns true if self is a date-time.

pub fn as_array(&self) -> Option<&Array>

Casts self to array.

pub fn as_array_mut(&mut self) -> Option<&mut Array>

Casts self to mutable array.

pub fn is_array(&self) -> bool

Returns true if self is an array.

pub fn as_inline_table(&self) -> Option<&InlineTable>

Casts self to inline table.

pub fn as_inline_table_mut(&mut self) -> Option<&mut InlineTable>

Casts self to mutable inline table.

pub fn is_inline_table(&self) -> bool

Returns true if self is an inline table.

pub fn as_table_like(&self) -> Option<&dyn TableLike>

Casts self to either a table or an inline table.

pub fn as_table_like_mut(&mut self) -> Option<&mut dyn TableLike>

Casts self to either a table or an inline table.

pub fn is_table_like(&self) -> bool

Returns true if self is either a table, or an inline table.

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

The location within the original document

This generally requires an ImDocument.

Trait Implementations

impl Clone for Item

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Formats the value using the given formatter.

impl Default for Item

fn default() -> Item

Returns the “default value” for a type.

impl Display for Item

Available on crate feature display only.

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

Formats the value using the given formatter.

impl<'b> From<&'b Item> for Item

fn from(s: &'b Item) -> Self

Converts to this type from the input type.

impl<V: Into<Value>> From<V> for Item

fn from(s: V) -> Self

Converts to this type from the input type.

impl FromStr for Item

Available on crate feature parse only.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a value from a &str

type Err = TomlError

The associated error which can be returned from parsing.

impl<I> Index<I> for Item

where I: Index,

type Output = Item

The returned type after indexing.

fn index(&self, index: I) -> &Item

Performs the indexing (container[index]) operation.

impl<I> IndexMut<I> for Item

where I: Index,

fn index_mut(&mut self, index: I) -> &mut Item

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

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 176 bytes

Size for each variant:

• None: 0 bytes
• Value: 176 bytes
• Table: 176 bytes
• ArrayOfTables: 56 bytes