Enum toml::value::Value

pub enum Value {
    String(String),
    Integer(i64),
    Float(f64),
    Boolean(bool),
    Datetime(Datetime),
    Array(Array),
    Table(Table),
}

Representation of a TOML value.

Variants

String(String)

Represents a TOML string

Integer(i64)

Represents a TOML integer

Float(f64)

Represents a TOML float

Boolean(bool)

Represents a TOML boolean

Datetime(Datetime)

Represents a TOML datetime

Array(Array)

Represents a TOML array

Table(Table)

Represents a TOML table

Methods

impl Value

fn try_from<T>(value: T) -> Result<Value, Error> where T: Serialize

Convert a T into toml::Value which is an enum that can represent any valid TOML data.

This conversion can fail if T's implementation of Serialize decides to fail, or if T contains a map with non-string keys.

fn try_into<T>(self) -> Result<T, Error> where T: Deserialize

Interpret a toml::Value as an instance of type T.

This conversion can fail if the structure of the Value does not match the structure expected by T, for example if T is a struct type but the Value contains something other than a TOML table. It can also fail if the structure is correct but T's implementation of Deserialize decides that something is wrong with the data, for example required struct fields are missing from the TOML map or some number is too big to fit in the expected primitive type.

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

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. Also returns None if the given key does not exist in the map or the given index is not within the bounds of the array.

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

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. Also returns None if the given key does not exist in the map or the given index is not within the bounds of the array.

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

Extracts the integer value if it is an integer.

fn is_integer(&self) -> bool

Tests whether this value is an integer

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

Extracts the float value if it is a float.

fn is_float(&self) -> bool

Tests whether this value is a float

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

Extracts the boolean value if it is a boolean.

fn is_bool(&self) -> bool

Tests whether this value is a boolean

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

Extracts the string of this value if it is a string.

fn is_str(&self) -> bool

Tests if this value is a string

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

Extracts the datetime value if it is a datetime.

Note that a parsed TOML value will only contain ISO 8601 dates. An example date is:

1979-05-27T07:32:00Z

fn is_datetime(&self) -> bool

Tests whether this value is a datetime

fn as_array(&self) -> Option<&Vec<Value>>

Extracts the array value if it is an array.

fn as_array_mut(&mut self) -> Option<&mut Vec<Value>>

Extracts the array value if it is an array.

fn is_array(&self) -> bool

Tests whether this value is an array

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

Extracts the table value if it is a table.

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

Extracts the table value if it is a table.

fn is_table(&self) -> bool

Extracts the table value if it is a table.

fn same_type(&self, other: &Value) -> bool

Tests whether this and another value have the same type.

fn type_str(&self) -> &'static str

Returns a human-readable representation of the type of this value.

Trait Implementations

impl PartialEq for Value

fn eq(&self, __arg_0: &Value) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Value) -> bool

This method tests for !=.

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<I> Index<I> for Value where I: Index

type Output = Value

The returned type after indexing

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

The method for the indexing (container[index]) operation

impl<I> IndexMut<I> for Value where I: Index

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

The method for the mutable indexing (container[index]) operation

impl From<String> for Value

fn from(val: String) -> Value

Performs the conversion.

impl From<i64> for Value

fn from(val: i64) -> Value

Performs the conversion.

impl From<f64> for Value

fn from(val: f64) -> Value

Performs the conversion.

impl From<bool> for Value

fn from(val: bool) -> Value

Performs the conversion.

impl From<Array> for Value

fn from(val: Array) -> Value

Performs the conversion.

impl From<Table> for Value

fn from(val: Table) -> Value

Performs the conversion.

impl From<Datetime> for Value

fn from(val: Datetime) -> Value

Performs the conversion.

impl Display for Value

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

Formats the value using the given formatter.

impl FromStr for Value

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Serialize for Value

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer

Serialize this value into the given Serde serializer.

impl Deserialize for Value

fn deserialize<D>(deserializer: D) -> Result<Value, D::Error> where D: Deserializer

Deserialize this value from the given Serde deserializer.

impl Deserializer for Value

type Error = Error

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

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

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

Hint that the Deserialize type is expecting an optional value.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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_unit<__V>(self, visitor: __V) -> Result<__V::Value, Self::Error> where __V: Visitor

Hint that the Deserialize type is expecting a unit value.

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

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

fn deserialize_seq_fixed_size<__V>(self,
                                   _: usize,
                                   visitor: __V)
                                   -> Result<__V::Value, Self::Error> where __V: Visitor

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_bytes<__V>(self, visitor: __V) -> Result<__V::Value, Self::Error> where __V: Visitor

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

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

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

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

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

fn deserialize_tuple_struct<__V>(self,
                                 _: &'static str,
                                 _: usize,
                                 visitor: __V)
                                 -> Result<__V::Value, Self::Error> where __V: Visitor

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

fn deserialize_struct<__V>(self,
                           _: &'static str,
                           _: &'static [&'static str],
                           visitor: __V)
                           -> Result<__V::Value, Self::Error> where __V: Visitor

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

fn deserialize_struct_field<__V>(self,
                                 visitor: __V)
                                 -> Result<__V::Value, Self::Error> where __V: Visitor

Hint that the Deserialize type is expecting the name of a struct field.

fn deserialize_tuple<__V>(self,
                          _: usize,
                          visitor: __V)
                          -> Result<__V::Value, Self::Error> where __V: Visitor

Hint that the Deserialize type is expecting a tuple value with a particular number of elements.

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

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

fn deserialize_enum<__V>(self,
                         _: &'static str,
                         _: &'static [&'static str],
                         visitor: __V)
                         -> Result<__V::Value, Self::Error> where __V: Visitor

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

fn deserialize_newtype_struct<__V>(self,
                                   _: &'static str,
                                   visitor: __V)
                                   -> Result<__V::Value, Self::Error> where __V: Visitor

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