Enum toml::Value

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

Representation of a TOML value.

Variants

String(String)

Integer(i64)

Float(f64)

Boolean(bool)

Datetime(String)

Array(Array)

Table(Table)

Implementations

impl Value

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

Tests whether this and another value have the same type.

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

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

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

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

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

Extracts the integer value if it is an integer.

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

Extracts the float value if it is a float.

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

Extracts the boolean value if it is a boolean.

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

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

pub fn as_slice(&self) -> Option<&[Value]>

Extracts the array value if it is an array.

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

Extracts the table value if it is a table.

pub fn lookup<'a>(&'a self, path: &'a str) -> Option<&'a Value>

Lookups for value at specified path.

Uses '.' as a path separator.

Note: arrays have zero-based indexes.

Note: empty path returns self.

let toml = r#"
     [test]
     foo = "bar"

     [[values]]
     foo = "baz"

     [[values]]
     foo = "qux"
"#;
let value: toml::Value = toml.parse().unwrap();

let foo = value.lookup("test.foo").unwrap();
assert_eq!(foo.as_str().unwrap(), "bar");

let foo = value.lookup("values.1.foo").unwrap();
assert_eq!(foo.as_str().unwrap(), "qux");

let no_bar = value.lookup("test.bar");
assert_eq!(no_bar.is_none(), true);

pub fn lookup_mut(&mut self, path: &str) -> Option<&mut Value>

Lookups for mutable value at specified path.

Uses '.' as a path separator.

Note: arrays have zero-based indexes.

Note: empty path returns self.

let toml = r#"
     [test]
     foo = "bar"

     [[values]]
     foo = "baz"

     [[values]]
     foo = "qux"
"#;
let mut value: toml::Value = toml.parse().unwrap();
{
   let string = value.lookup_mut("test.foo").unwrap();
   assert_eq!(string, &mut toml::Value::String(String::from("bar")));
   *string = toml::Value::String(String::from("foo"));
}
let result = value.lookup_mut("test.foo").unwrap();
assert_eq!(result.as_str().unwrap(), "foo");

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 Encodable for Value

fn encode<E>(&self, e: &mut E) -> Result<(), E::Error> where
    E: Encoder, 

Serialize a value using an Encoder.

impl FromStr for Value

type Err = Vec<ParserError>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Value, Vec<ParserError>>

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

impl PartialEq<Value> for Value

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

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

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

This method tests for !=.

impl StructuralPartialEq for Value