Struct toml_span::value::Value

pub struct Value<'de> {
    pub span: Span,
    /* private fields */
}

A deserialized ValueInner with accompanying Span information for where it was located in the toml document

Fields

span: Span

The location of the value in the toml document

Implementations

impl<'de> Value<'de>

pub fn new(value: ValueInner<'de>) -> Self

Creates a new Value with an empty Span

pub fn with_span(value: ValueInner<'de>, span: Span) -> Self

Creates a new Value with the specified Span

pub fn take(&mut self) -> ValueInner<'de>

Takes the inner ValueInner

This panics if the inner value has already been taken.

Typically paired with Self::set

pub fn set(&mut self, value: ValueInner<'de>)

Sets the inner ValueInner

This is typically done when the value is taken with Self::take, processed, and returned

pub fn has_keys(&self) -> bool

Returns true if the value is a table and is non-empty

pub fn has_key(&self, key: &str) -> bool

Returns true if the value is a table and has the specified key

pub fn take_string( &mut self, msg: Option<&'static str>, ) -> Result<Cow<'de, str>, Error>

Takes the value as a string, returning an error with either a default or user supplied message

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

Returns a borrowed string if this is a ValueInner::String

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

Returns a borrowed table if this is a ValueInner::Table

pub fn as_array(&self) -> Option<&Array<'de>>

Returns a borrowed array if this is a ValueInner::Array

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

Returns an i64 if this is a ValueInner::Integer

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

Returns an f64 if this is a ValueInner::Float

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

Returns a bool if this is a ValueInner::Boolean

pub fn pointer(&self, pointer: &'de str) -> Option<&Self>

Uses JSON pointer-like syntax to lookup a specific Value

The basic format is:

• The path starts with /
• Each segment is separated by a /
• Each segment is either a key name, or an integer array index

let data = "[x]\ny = ['z', 'zz']";
let value = toml_span::parse(data).unwrap();
assert_eq!(value.pointer("/x/y/1").unwrap().as_str().unwrap(), "zz");
assert!(value.pointer("/a/b/c").is_none());

Note that this is JSON pointer**-like** because / is not supported in key names because I don’t see the point. If you want this it is easy to implement.

pub fn pointer_mut(&mut self, pointer: &'de str) -> Option<&mut Self>

The mut version of Self::pointer

Trait Implementations

impl<'de> AsRef<ValueInner<'de>> for Value<'de>

fn as_ref(&self) -> &ValueInner<'de>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'de> Debug for Value<'de>

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

Formats the value using the given formatter.

impl<'de> Serialize for Value<'de>

Available on crate feature serde only.

fn serialize<S>(&self, ser: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.