Enum rocket::config::Value

pub enum Value {
    String(String),
    Integer(i64),
    Float(f64),
    Boolean(bool),
    Datetime(Datetime),
    Array(Vec<Value, Global>),
    Table(BTreeMap<String, Value>),
}

Representation of a TOML value.

Variants

String(String)

Represents a TOML string

Tuple Fields of String

0: String

Integer(i64)

Represents a TOML integer

Tuple Fields of Integer

0: i64

Float(f64)

Represents a TOML float

Tuple Fields of Float

0: f64

Boolean(bool)

Represents a TOML boolean

Tuple Fields of Boolean

0: bool

Datetime(Datetime)

Represents a TOML datetime

Tuple Fields of Datetime

0: Datetime

Array(Vec<Value, Global>)

Represents a TOML array

Tuple Fields of Array

0: Vec<Value, Global>

Table(BTreeMap<String, Value>)

Represents a TOML table

Tuple Fields of Table

0: BTreeMap<String, Value>

Implementations

impl Value

pub fn try_from<T>(value: T) -> Result<Value, Error> where
    T: Serialize, 

Convert a T into toml::Value which is an enum that can represent any valid TOML data.

This conversion can fail if T’s implementation of Serialize decides to fail, or if T contains a map with non-string keys.

pub fn try_into<'de, T>(self) -> Result<T, Error> where
    T: Deserialize<'de>, 

Interpret a toml::Value as an instance of type T.

This conversion can fail if the structure of the Value does not match the structure expected by T, for example if T is a struct type but the Value contains something other than a TOML table. It can also fail if the structure is correct but T’s implementation of Deserialize decides that something is wrong with the data, for example required struct fields are missing from the TOML map or some number is too big to fit in the expected primitive type.

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

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>(&mut self, index: I) -> Option<&mut Value> where
    I: Index, 

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<Value, Global>>

Extracts the array value if it is an array.

pub fn as_array_mut(&mut self) -> Option<&mut Vec<Value, Global>>

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<&BTreeMap<String, Value>>

Extracts the table value if it is a table.

pub fn as_table_mut(&mut self) -> Option<&mut BTreeMap<String, Value>>

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: &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.

Trait Implementations

impl Clone for Value

pub 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

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Value

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

Deserialize this value from the given Serde deserializer.

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

type Error = Error

The error type that can be returned if some error occurs during deserialization.

pub fn deserialize_any<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, 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.

pub fn deserialize_enum<V>(
    self,
    _name: &str,
    _variants: &'static [&'static str],
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

pub fn deserialize_option<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an optional value.

pub fn deserialize_newtype_struct<V>(
    self,
    _name: &'static str,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a newtype struct with a particular name.

pub fn deserialize_bool<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a bool value.

pub fn deserialize_u8<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u8 value.

pub fn deserialize_u16<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u16 value.

pub fn deserialize_u32<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u32 value.

pub fn deserialize_u64<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u64 value.

pub fn deserialize_i8<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i8 value.

pub fn deserialize_i16<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i16 value.

pub fn deserialize_i32<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i32 value.

pub fn deserialize_i64<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i64 value.

pub fn deserialize_f32<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a f32 value.

pub fn deserialize_f64<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a f64 value.

pub fn deserialize_char<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a char value.

pub fn deserialize_str<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::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.

pub fn deserialize_string<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::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.

pub fn deserialize_unit<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a unit value.

pub fn deserialize_seq<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a sequence of values.

pub fn deserialize_bytes<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::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.

pub fn deserialize_byte_buf<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::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.

pub fn deserialize_map<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a map of key-value pairs.

pub fn deserialize_unit_struct<V>(
    self,
    name: &'static str,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a unit struct with a particular name.

pub fn deserialize_tuple_struct<V>(
    self,
    name: &'static str,
    len: usize,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.

pub fn deserialize_struct<V>(
    self,
    name: &'static str,
    fields: &'static [&'static str],
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a struct with a particular name and fields.

pub fn deserialize_tuple<V>(
    self,
    len: usize,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::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.

pub fn deserialize_ignored_any<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored.

pub fn deserialize_identifier<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::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

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

Formats the value using the given formatter.

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

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

Performs the conversion.

impl<S, V> From<BTreeMap<S, V>> for Value where
    S: Into<String>,
    V: Into<Value>, 

pub fn from(val: BTreeMap<S, V>) -> Value

Performs the conversion.

impl From<Datetime> for Value

pub fn from(val: Datetime) -> Value

Performs the conversion.

impl<S, V> From<HashMap<S, V, RandomState>> for Value where
    S: Into<String> + Hash + Eq,
    V: Into<Value>, 

pub fn from(val: HashMap<S, V, RandomState>) -> Value

Performs the conversion.

impl From<String> for Value

pub fn from(val: String) -> Value

Performs the conversion.

impl<V> From<Vec<V, Global>> for Value where
    V: Into<Value>, 

pub fn from(val: Vec<V, Global>) -> Value

Performs the conversion.

impl From<bool> for Value

pub fn from(val: bool) -> Value

Performs the conversion.

impl From<f32> for Value

pub fn from(val: f32) -> Value

Performs the conversion.

impl From<f64> for Value

pub fn from(val: f64) -> Value

Performs the conversion.

impl From<i32> for Value

pub fn from(val: i32) -> Value

Performs the conversion.

impl From<i64> for Value

pub fn from(val: i64) -> Value

Performs the conversion.

impl From<i8> for Value

pub fn from(val: i8) -> Value

Performs the conversion.

impl From<u32> for Value

pub fn from(val: u32) -> Value

Performs the conversion.

impl From<u8> for Value

pub fn from(val: u8) -> Value

Performs the conversion.

impl FromStr for Value

type Err = Error

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<Value, <Value as FromStr>::Err>

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

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

type Output = Value

The returned type after indexing.

pub fn index(&self, index: I) -> &Value

Performs the indexing (container[index]) operation.

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

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

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

impl<'de> IntoDeserializer<'de, Error> for Value

type Deserializer = Value

The type of the deserializer being converted into.

pub fn into_deserializer(self) -> Value

Convert this value into a deserializer.

impl PartialEq<Value> for Value

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

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

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

This method tests for !=.

impl Serialize for Value

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Value