# Enum toml::value::Value

source · [−]

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

Expand description

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

## Implementations

source

### impl Value

source

#### pub 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.

source

#### pub fn try_into<'de, T>(self) -> Result<T, Error> where
T: Deserialize<'de>,

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.

source

#### pub 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.

source

#### pub 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.

source

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

Extracts the integer value if it is an integer.

source

#### pub fn is_integer(&self) -> bool

Tests whether this value is an integer.

source

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

Extracts the float value if it is a float.

source

#### pub fn is_float(&self) -> bool

Tests whether this value is a float.

source

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

Extracts the boolean value if it is a boolean.

source

#### pub fn is_bool(&self) -> bool

Tests whether this value is a boolean.

source

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

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

source

#### pub fn is_str(&self) -> bool

Tests if this value is a string.

source

#### pub 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

source

#### pub fn is_datetime(&self) -> bool

Tests whether this value is a datetime.

source

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

Extracts the array value if it is an array.

source

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

Extracts the array value if it is an array.

source

#### pub fn is_array(&self) -> bool

Tests whether this value is an array.

source

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

Extracts the table value if it is a table.

source

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

Extracts the table value if it is a table.

source

#### pub fn is_table(&self) -> bool

Tests whether this value is a table.

source

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

Tests whether this and another value have the same type.

source

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

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

## Trait Implementations

source

### impl Clone for Value

source

#### fn clone(&self) -> Value

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 Value

source

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

Formats the value using the given formatter. Read more

source

### impl<'de> Deserialize<'de> for Value

source

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

Deserialize this value from the given Serde deserializer. Read more

source

### impl<'de> Deserializer<'de> for Value

#### type Error = Error

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

source

#### fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, 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. Read more

source

#### fn deserialize_enum<V>(
self,
_name: &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. Read more

source

#### 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. Read more

source

#### 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. Read more

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

#### 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`. Read more

source

#### 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`. Read more

source

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

source

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

source

#### 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`. Read more

source

#### 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`. Read more

source

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

source

#### 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. Read more

source

#### 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. Read more

source

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

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

source

#### 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. Read more

source

#### 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. Read more

source

#### 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. Read more

source

#### 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. Read more

source

#### 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. Read more

source

#### fn is_human_readable(&self) -> bool

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

source

### impl Display for Value

source

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

Formats the value using the given formatter. Read more

source

### impl<'a> From<&'a str> for Value

source

#### fn from(val: &'a str) -> Value

Converts to this type from the input type.

source

### impl<S: Into<String>, V: Into<Value>> From<BTreeMap<S, V, Global>> for Value

source

#### fn from(val: BTreeMap<S, V>) -> Value

Converts to this type from the input type.

source

### impl From<Datetime> for Value

source

#### fn from(val: Datetime) -> Value

Converts to this type from the input type.

source

### impl<S: Into<String> + Hash + Eq, V: Into<Value>> From<HashMap<S, V, RandomState>> for Value

source

#### fn from(val: HashMap<S, V>) -> Value

Converts to this type from the input type.

source

### impl From<Map<String, Value>> for Value

source

#### fn from(val: Table) -> Value

Converts to this type from the input type.

source

### impl From<String> for Value

source

#### fn from(val: String) -> Value

Converts to this type from the input type.

source

### impl<V: Into<Value>> From<Vec<V, Global>> for Value

source

#### fn from(val: Vec<V>) -> Value

Converts to this type from the input type.

source

### impl From<bool> for Value

source

#### fn from(val: bool) -> Value

Converts to this type from the input type.

source

### impl From<f32> for Value

source

#### fn from(val: f32) -> Value

Converts to this type from the input type.

source

### impl From<f64> for Value

source

#### fn from(val: f64) -> Value

Converts to this type from the input type.

source

### impl From<i32> for Value

source

#### fn from(val: i32) -> Value

Converts to this type from the input type.

source

### impl From<i64> for Value

source

#### fn from(val: i64) -> Value

Converts to this type from the input type.

source

### impl From<i8> for Value

source

#### fn from(val: i8) -> Value

Converts to this type from the input type.

source

### impl From<u32> for Value

source

#### fn from(val: u32) -> Value

Converts to this type from the input type.

source

### impl From<u8> for Value

source

#### fn from(val: u8) -> Value

Converts to this type from the input type.

source

### impl FromStr for Value

#### type Err = Error

The associated error which can be returned from parsing.

source

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

Parses a string `s` to return a value of this type. Read more

source

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

#### type Output = Value

The returned type after indexing.

source

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

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

source

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

source

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

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

source

### impl<'de> IntoDeserializer<'de, Error> for Value

#### type Deserializer = Value

The type of the deserializer being converted into.

source

#### fn into_deserializer(self) -> Self

Convert this value into a deserializer.

source

### impl PartialEq<Value> for Value

source

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

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

source

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

This method tests for `!=`.

source

### impl Serialize for Value

source

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

Serialize this value into the given Serde serializer. Read more

source

### impl StructuralPartialEq for Value

## Auto Trait Implementations

### impl RefUnwindSafe for Value

### impl Send for Value

### impl Sync for Value

### impl Unpin for Value

### impl UnwindSafe for Value

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

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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.

const: unstable · 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.

const: unstable · source

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

Performs the conversion.

source

### impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,