Enum toml_spanned_value::spanned_value::ValueKind

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

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

Methods

impl ValueKind

pub fn get<I: Index>(&self, index: I) -> Option<&SpannedValue>

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.

pub fn get_mut<I: Index>(&mut self, index: I) -> Option<&mut SpannedValue>

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.

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

Extracts the integer value if it is an integer.

pub fn is_integer(&self) -> bool

Tests whether this value is an integer.

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

Extracts the float value if it is a float.

pub fn is_float(&self) -> bool

Tests whether this value is a float.

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

Extracts the boolean value if it is a boolean.

pub fn is_bool(&self) -> bool

Tests whether this value is a boolean.

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

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

pub fn is_str(&self) -> bool

Tests if this value is a string.

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

pub fn is_datetime(&self) -> bool

Tests whether this value is a datetime.

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

Extracts the array value if it is an array.

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

Extracts the array value if it is an array.

pub fn is_array(&self) -> bool

Tests whether this value is an array.

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

Extracts the table value if it is a table.

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

Extracts the table value if it is a table.

pub fn is_table(&self) -> bool

Tests whether this value is a table.

pub fn same_type(&self, other: &ValueKind) -> 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.

Trait Implementations

impl<'a> From<&'a str> for ValueKind

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

Performs the conversion.

impl<V: Into<SpannedValue>> From<Vec<V>> for ValueKind

fn from(val: Vec<V>) -> ValueKind

Performs the conversion.

impl From<String> for ValueKind

fn from(val: String) -> ValueKind

Performs the conversion.

impl From<i64> for ValueKind

fn from(val: i64) -> ValueKind

Performs the conversion.

impl From<i32> for ValueKind

fn from(val: i32) -> ValueKind

Performs the conversion.

impl From<i8> for ValueKind

fn from(val: i8) -> ValueKind

Performs the conversion.

impl From<u8> for ValueKind

fn from(val: u8) -> ValueKind

Performs the conversion.

impl From<u32> for ValueKind

fn from(val: u32) -> ValueKind

Performs the conversion.

impl From<f64> for ValueKind

fn from(val: f64) -> ValueKind

Performs the conversion.

impl From<f32> for ValueKind

fn from(val: f32) -> ValueKind

Performs the conversion.

impl From<bool> for ValueKind

fn from(val: bool) -> ValueKind

Performs the conversion.

impl From<Datetime> for ValueKind

fn from(val: Datetime) -> ValueKind

Performs the conversion.

impl From<Map<Spanned<String>, Spanned<ValueKind>>> for ValueKind

fn from(val: Table) -> ValueKind

Performs the conversion.

impl Clone for ValueKind

fn clone(&self) -> ValueKind

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialEq<ValueKind> for ValueKind

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

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

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

This method tests for !=.

impl Display for ValueKind

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

Formats the value using the given formatter.

impl Debug for ValueKind

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

Formats the value using the given formatter.

impl FromStr for ValueKind

type Err = Error

The associated error which can be returned from parsing.

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

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

impl<I> Index<I> for ValueKind where
    I: Index, 

type Output = SpannedValue

The returned type after indexing.

fn index(&self, index: I) -> &SpannedValue

Performs the indexing (container[index]) operation.

impl<I> IndexMut<I> for ValueKind where
    I: Index, 

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

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

impl StructuralPartialEq for ValueKind

impl Serialize for ValueKind

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for ValueKind

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

Deserialize this value from the given Serde deserializer.