Enum toml_edit::Value

pub enum Value {
    String(Formatted<String>),
    Integer(Formatted<i64>),
    Float(Formatted<f64>),
    Boolean(Formatted<bool>),
    Datetime(Formatted<Datetime>),
    Array(Array),
    InlineTable(InlineTable),
}

Representation of a TOML Value (as part of a Key/Value Pair).

Variants

String(Formatted<String>)

A string value.

Integer(Formatted<i64>)

A 64-bit integer value.

Float(Formatted<f64>)

A 64-bit float value.

Boolean(Formatted<bool>)

A boolean value.

Datetime(Formatted<Datetime>)

An RFC 3339 formatted date-time with offset.

Array(Array)

An inline array of values.

InlineTable(InlineTable)

An inline table of key/value pairs.

Implementations

impl Value

Downcasting

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

Text description of value type

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

Casts self to str.

pub fn is_str(&self) -> bool

Returns true iff self is a string.

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

Casts self to integer.

pub fn is_integer(&self) -> bool

Returns true iff self is an integer.

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

Casts self to float.

pub fn is_float(&self) -> bool

Returns true iff self is a float.

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

Casts self to boolean.

pub fn is_bool(&self) -> bool

Returns true iff self is a boolean.

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

Casts self to date-time.

pub fn is_datetime(&self) -> bool

Returns true iff 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 iff 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 iff self is an inline table.

impl Value

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

Get the decoration of the value.

Example

let v = toml_edit::Value::from(true);
assert_eq!(v.decor().suffix(), None);

pub fn decor(&self) -> &Decor

Get the decoration of the value.

Example

let v = toml_edit::Value::from(true);
assert_eq!(v.decor().suffix(), None);

pub fn decorated(self, prefix: &str, suffix: &str) -> Self

Sets the prefix and the suffix for value.

Example

let mut v = toml_edit::Value::from(42);
assert_eq!(&v.to_string(), "42");
let d = v.decorated(" ", " ");
assert_eq!(&d.to_string(), " 42 ");

Trait Implementations

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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

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_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_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_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_newtype_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 newtype struct with a particular name.

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 Value

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

Formats the value using the given formatter.

impl<'b> From<&'b InternalString> for Value

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

Converts to this type from the input type.

impl<'b> From<&'b String> for Value

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'b> From<&'b str> for Value

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

Converts to this type from the input type.

impl From<Array> for Value

fn from(array: Array) -> Self

Converts to this type from the input type.

impl From<Date> for Value

fn from(d: Date) -> Self

Converts to this type from the input type.

impl From<Datetime> for Value

fn from(d: Datetime) -> Self

Converts to this type from the input type.

impl From<InlineTable> for Value

fn from(table: InlineTable) -> Self

Converts to this type from the input type.

impl From<InternalString> for Value

fn from(s: InternalString) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Time> for Value

fn from(d: Time) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(f: f64) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(i: i64) -> Self

Converts to this type from the input type.

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

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

Creates a value from an iterator.

impl<V: Into<Value>> FromIterator<V> for Value

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

Creates a value from an iterator.

impl FromStr for Value

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<'de> IntoDeserializer<'de, Error> for Value

type Deserializer = Value

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self

Convert this value into a deserializer.