Skip to main content

Value

Enum Value 

Source
pub enum Value {
    Scalar(String),
    Array(Vec<Value>),
    Object(IndexMap<String, Value>),
}
Expand description

A node in the structprop value tree produced by parse().

The tree maps directly onto structprop’s three syntactic forms:

Structprop syntaxVariant
key = valueValue::Scalar
key = { a b c }Value::Array of Value::Scalars
key = { { k = v } { k = v } }Value::Array of Value::Objects
key { … }Value::Object

Scalar strings are stored verbatim (no coercion at parse time); numeric or boolean coercion is performed lazily via the Value::as_bool, Value::as_i64, and Value::as_f64 helpers. Duplicate keys within any object block are detected and rejected during parsing.

Variants§

§

Scalar(String)

A bare or quoted string token, stored as-is (no coercion applied).

Use Value::as_bool, Value::as_i64, or Value::as_f64 to attempt type coercion, or Value::is_null to test for null.

§

Array(Vec<Value>)

An ordered list of values, corresponding to key = { … } syntax.

Array items may be Value::Scalars (bare terms) or Value::Objects (written as { key = val … } inline sub-objects). Duplicate keys within a sub-object are rejected at parse time.

§

Object(IndexMap<String, Value>)

An ordered map from string keys to values, corresponding to either a key { … } block or the implicit top-level document object.

Key insertion order is preserved via IndexMap.

Implementations§

Source§

impl Value

Source

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

Try to interpret this Value::Scalar as a bool.

Returns Some(true) for the literal string "true", Some(false) for "false", and None for any other value or non-scalar variant.

This mirrors the Python implementation’s json.loads coercion.

Source

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

Try to interpret this Value::Scalar as an i64.

Returns Some(n) if the string parses as a signed 64-bit integer, or None otherwise.

Source

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

Try to interpret this Value::Scalar as an f64.

Returns Some(n) if the string parses as a 64-bit float, or None otherwise.

Source

pub fn is_null(&self) -> bool

Returns true if this value is the scalar string "null".

Used by the deserializer to map structprop’s null token to Option::None.

Source

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

Return the inner string of a Value::Scalar, or None for other variants.

This complements Value::as_bool, Value::as_i64, and Value::as_f64 for cases where the raw string value is needed.

§Examples
use serde_structprop::parse::{parse, Value};

let v = parse("greeting = hello\n").unwrap();
if let Value::Object(map) = v {
    assert_eq!(map["greeting"].as_str(), Some("hello"));
}
Source

pub fn type_name(&self) -> &'static str

Returns a short human-readable name for the variant, used in error messages.

Trait Implementations§

Source§

impl Clone for Value

Source§

fn clone(&self) -> Value

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Value

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Value

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

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

§

impl UnwindSafe for Value

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.