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 if self is a string.

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

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: impl Into<RawString>, suffix: impl Into<RawString>, ) -> 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 ");

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

The location within the original document

This generally requires an ImDocument.

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 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 = ValueDeserializer

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.