Enum toml::Value

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

Expand description

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);

Trait Implementations§

impl Clone for Value

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

impl Debug for Value

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

Formats the value using the given formatter. Read more

impl Display for Value

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

Formats the value using the given formatter. Read more

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

impl PartialEq for Value

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

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

1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Value

Auto Trait Implementations§

impl Freeze for Value

impl RefUnwindSafe for Value

impl Send for Value

impl Sync for Value

impl Unpin for Value

impl UnwindSafe for Value

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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.

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

Performs the conversion.