Value

Enum Value 

Source
pub enum Value {
    Null,
    Bool(bool),
    Integer(i64),
    Float(f64),
    String(String),
    Array(Vec<Value>),
    Table(BTreeMap<String, Value>),
}
Expand description

Represents a configuration value.

Variants§

§

Null

Null/empty value

§

Bool(bool)

Boolean value

§

Integer(i64)

Integer value

§

Float(f64)

Floating point value

§

String(String)

String value

§

Array(Vec<Value>)

Array of values

§

Table(BTreeMap<String, Value>)

Table (key-value pairs)

Implementations§

Source§

impl Value

Source

pub fn null() -> Self

Create a new null value

Source

pub fn bool(value: bool) -> Self

Create a new boolean value

Source

pub fn integer(value: i64) -> Self

Create a new integer value

Source

pub fn float(value: f64) -> Self

Create a new float value

Source

pub fn string<S: Into<String>>(value: S) -> Self

Create a new string value

Source

pub fn array(values: Vec<Value>) -> Self

Create a new array value

Source

pub fn table(table: BTreeMap<String, Value>) -> Self

Create a new table value

Source

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

Get the type name of this value

Source

pub fn is_null(&self) -> bool

Check if this value is null

Source

pub fn is_bool(&self) -> bool

Check if this value is a boolean

Source

pub fn is_integer(&self) -> bool

Check if this value is an integer

Source

pub fn is_float(&self) -> bool

Check if this value is a float

Source

pub fn is_string(&self) -> bool

Check if this value is a string

Source

pub fn is_array(&self) -> bool

Check if this value is an array

Source

pub fn is_table(&self) -> bool

Check if this value is a table

Source

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

Try to convert this value to a boolean

Source

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

Try to convert this value to an integer

Source

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

Try to convert this value to a float

Source

pub fn as_string(&self) -> Result<&str>

Try to convert this value to a string - ZERO-COPY optimized

Source

pub fn to_string_representation(&self) -> Result<String>

Convert this value to a string representation (allocating)

Source

pub fn as_array(&self) -> Result<&Vec<Value>>

Try to get this value as an array

Source

pub fn as_array_mut(&mut self) -> Result<&mut Vec<Value>>

Try to get this value as a mutable array

Source

pub fn as_table(&self) -> Result<&BTreeMap<String, Value>>

Try to get this value as a table

Source

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

Try to get this value as a mutable table

Source

pub fn get(&self, path: &str) -> Option<&Value>

Get a value by path (dot-separated)

Source

pub fn get_mut_nested(&mut self, path: &str) -> Result<&mut Value>

Get a mutable reference to a value by path (ENTERPRISE ERROR HANDLING)

Source

pub fn set_nested(&mut self, path: &str, value: Value) -> Result<()>

Set a value by path, creating intermediate tables as needed (ZERO-COPY optimized)

Source

pub fn remove(&mut self, path: &str) -> Result<Option<Value>>

Remove a value by path (ENTERPRISE ERROR HANDLING)

Source

pub fn keys(&self) -> Result<Vec<&str>>

Get all keys at the current level (for tables only) - ZERO-COPY optimized

Source

pub fn contains_key(&self, path: &str) -> bool

Check if a path exists

Source

pub fn set(&mut self, path: &str, value: Value) -> Result<()>

Set a value by path (backward compatibility alias)

Source

pub fn len(&self) -> usize

Get the length of arrays or tables

Source

pub fn is_empty(&self) -> bool

Check if arrays or tables are empty

Source§

impl Value

Source

pub fn string_from_slice(value: &str) -> Self

Create a string value from a slice without unnecessary allocation

Source

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

Get string slice without allocation - enterprise optimization

Trait Implementations§

Source§

impl Clone for Value

Source§

fn clone(&self) -> Value

Returns a duplicate of the value. Read more
1.0.0 · 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 Display for Value

Source§

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

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

impl From<&str> for Value

Source§

fn from(value: &str) -> Self

Converts to this type from the input type.
Source§

impl From<BTreeMap<String, Value>> for Value

Source§

fn from(value: BTreeMap<String, Value>) -> Self

Converts to this type from the input type.
Source§

impl From<String> for Value

Source§

fn from(value: String) -> Self

Converts to this type from the input type.
Source§

impl From<Value> for Config

Convert Value to Config

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl From<Vec<Value>> for Value

Source§

fn from(value: Vec<Value>) -> Self

Converts to this type from the input type.
Source§

impl From<bool> for Value

Source§

fn from(value: bool) -> Self

Converts to this type from the input type.
Source§

impl From<f32> for Value

Source§

fn from(value: f32) -> Self

Converts to this type from the input type.
Source§

impl From<f64> for Value

Source§

fn from(value: f64) -> Self

Converts to this type from the input type.
Source§

impl From<i32> for Value

Source§

fn from(value: i32) -> Self

Converts to this type from the input type.
Source§

impl From<i64> for Value

Source§

fn from(value: i64) -> Self

Converts to this type from the input type.
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 · 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 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.