Enum Value 

pub enum Value {
    Null,
    Bool(bool),
    Int(i64),
    Float(f64),
    String(String),
    Sequence(Vec<Value>),
    Mapping(IndexMap<Value, Value>),
}

A YAML value with all possible types

Variants

Null

Null value

Bool(bool)

Boolean value

Int(i64)

Integer value

Float(f64)

Floating point value

String(String)

String value

Sequence(Vec<Value>)

Sequence (array/list) value

Mapping(IndexMap<Value, Value>)

Mapping (dictionary/object) value

Implementations

impl Value

pub const fn null() -> Self

Create a null value

pub const fn bool(b: bool) -> Self

Create a boolean value

pub const fn int(i: i64) -> Self

Create an integer value

pub const fn float(f: f64) -> Self

Create a float value

pub fn string(s: impl Into<String>) -> Self

Create a string value

pub const fn sequence() -> Self

Create an empty sequence

pub const fn sequence_with(values: Vec<Self>) -> Self

Create a sequence with values

pub fn mapping() -> Self

Create an empty mapping

pub fn mapping_with(pairs: Vec<(Self, Self)>) -> Self

Create a mapping with key-value pairs

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

Get the type name of this value

pub const fn is_null(&self) -> bool

Check if this value is null

pub const fn is_bool(&self) -> bool

Check if this value is a boolean

pub const fn is_int(&self) -> bool

Check if this value is an integer

pub const fn is_float(&self) -> bool

Check if this value is a float

pub const fn is_string(&self) -> bool

Check if this value is a string

pub const fn is_sequence(&self) -> bool

Check if this value is a sequence

pub const fn is_mapping(&self) -> bool

Check if this value is a mapping

pub const fn is_number(&self) -> bool

Check if this value is a number (int or float)

pub fn len(&self) -> Option<usize>

Get the length of sequences and mappings, None for scalars

pub fn is_empty(&self) -> bool

Check if sequences, mappings, or strings are empty

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

Get this value as a boolean, if possible

pub const fn as_int(&self) -> Option<i64>

Get this value as an integer, if possible

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

Get this value as a float, if possible

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

Get this value as a string reference, if possible

pub const fn as_sequence(&self) -> Option<&Vec<Self>>

Get this value as a sequence reference, if possible

pub const fn as_sequence_mut(&mut self) -> Option<&mut Vec<Self>>

Get this value as a mutable sequence reference, if possible

pub const fn as_mapping(&self) -> Option<&IndexMap<Self, Self>>

Get this value as a mapping reference, if possible

pub const fn as_mapping_mut(&mut self) -> Option<&mut IndexMap<Self, Self>>

Get this value as a mutable mapping reference, if possible

pub fn get(&self, index: &Self) -> Option<&Self>

Index into a sequence or mapping

pub fn get_str(&self, key: &str) -> Option<&Self>

Convenience method to get a value by string key

pub fn get_index(&self, index: usize) -> Option<&Self>

Get a value by numeric index (for sequences)

pub fn get_mut(&mut self, index: &Self) -> Option<&mut Self>

Mutably index into a sequence or mapping

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate 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 Display for Value

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

Formats the value using the given formatter.

impl From<&str> for Value

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<()> for Value

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<BorrowedValue<'_>> for Value

fn from(value: BorrowedValue<'_>) -> Self

Converts to this type from the input type.

impl From<IndexMap<Value, Value>> for Value

fn from(map: IndexMap<Self, Self>) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(s: String) -> Self

Converts to this type from the input type.

impl<'a> From<Value> for BorrowedValue<'a>

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<Value> for CommentedValue

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<Vec<Value>> for Value

fn from(seq: Vec<Self>) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Value

fn from(f: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(f: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(i: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(i: i64) -> Self

Converts to this type from the input type.

impl Hash for Value

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Value

fn eq(&self, other: &Self) -> 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 Serialize for Value

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Value