Struct Value

pub struct Value {
    pub kind: ValueKind,
    /* private fields */
}

A configuration value.

Fields

kind: ValueKind

Underlying kind of the configuration value.

Implementations

impl Value

pub fn new<V>(origin: Option<&String>, kind: V) -> Self

where V: Into<ValueKind>,

Create a new value instance that will remember its source uri.

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

Get the description of the original location of the value.

pub fn try_deserialize<'de, T: Deserialize<'de>>(self) -> Result<T, ConfigError>

Attempt to deserialize this value into the requested type.

pub fn into_bool(self) -> Result<bool, ConfigError>

Returns self as a bool, if possible.

pub fn into_int(self) -> Result<i64, ConfigError>

Returns self into an i64, if possible.

pub fn into_int128(self) -> Result<i128, ConfigError>

Returns self into an i128, if possible.

pub fn into_uint(self) -> Result<u64, ConfigError>

Returns self into an u64, if possible.

pub fn into_uint128(self) -> Result<u128, ConfigError>

Returns self into an u128, if possible.

pub fn into_float(self) -> Result<f64, ConfigError>

Returns self into a f64, if possible.

pub fn into_string(self) -> Result<String, ConfigError>

Returns self into a string, if possible.

pub fn into_array(self) -> Result<Vec<Self>, ConfigError>

Returns self into an array, if possible

pub fn into_table(self) -> Result<Map<String, Self>, ConfigError>

If the Value is a Table, returns the associated Map.

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

fn default() -> Value

Returns the “default value” for a type.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

type Error = ConfigError

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

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, ConfigError>

where V: Visitor<'de>,

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input.

fn deserialize_bool<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a bool value.

fn deserialize_i8<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_u8<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_f32<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_str<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_string<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, ConfigError>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an optional value.

fn deserialize_newtype_struct<V>( self, _name: &'static str, visitor: V, ) -> Result<V::Value, ConfigError>

where V: Visitor<'de>,

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

fn deserialize_enum<V>( self, name: &'static str, variants: &'static [&'static str], visitor: V, ) -> Result<V::Value, ConfigError>

where V: Visitor<'de>,

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

fn deserialize_char<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a char value.

fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

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

fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value, Self::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.

fn deserialize_byte_buf<V>(self, visitor: V) -> Result<V::Value, Self::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.

fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

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

fn deserialize_struct<V>( self, name: &'static str, fields: &'static [&'static str], visitor: V, ) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

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

fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit value.

fn deserialize_identifier<V>(self, visitor: V) -> Result<V::Value, Self::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_ignored_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

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

fn deserialize_unit_struct<V>( self, name: &'static str, visitor: V, ) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

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

fn deserialize_tuple_struct<V>( self, name: &'static str, len: usize, visitor: V, ) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

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

fn deserialize_tuple<V>( self, len: usize, visitor: V, ) -> Result<V::Value, Self::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.

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

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

Formats the value using the given formatter.

impl<T> From<T> for Value

where T: Into<ValueKind>,

fn from(value: T) -> Self

Converts to this type from the input type.

impl PartialEq for Value

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Value