Enum BorrowedValue 

pub enum BorrowedValue<'a> {
    Null,
    Bool(bool),
    Int(i64),
    Float(f64),
    String(Cow<'a, str>),
    Sequence(Vec<BorrowedValue<'a>>),
    Mapping(IndexMap<BorrowedValue<'a>, BorrowedValue<'a>>),
}

A zero-copy YAML value that borrows data where possible

Variants

Null

Null value

Bool(bool)

Boolean value

Int(i64)

Integer value

Float(f64)

Floating point value

String(Cow<'a, str>)

String value (borrowed or owned)

Sequence(Vec<BorrowedValue<'a>>)

Sequence (array/list) value

Mapping(IndexMap<BorrowedValue<'a>, BorrowedValue<'a>>)

Mapping (dictionary/object) value

Implementations

impl<'a> BorrowedValue<'a>

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 const fn borrowed_string(s: &'a str) -> Self

Create a borrowed string value

pub fn owned_string(s: String) -> Self

Create an owned string value

pub const fn string(s: Cow<'a, str>) -> Self

Create a string value from a Cow

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 as_bool(&self) -> Option<bool>

Try to get this value as a boolean

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

Try to get this value as an integer

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

Try to get this value as a float

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

Try to get this value as a string slice

pub const fn as_sequence(&self) -> Option<&Vec<BorrowedValue<'a>>>

Try to get this value as a sequence

pub fn as_sequence_mut(&mut self) -> Option<&mut Vec<BorrowedValue<'a>>>

Try to get this value as a mutable sequence

pub const fn as_mapping( &self, ) -> Option<&IndexMap<BorrowedValue<'a>, BorrowedValue<'a>>>

Try to get this value as a mapping

pub fn as_mapping_mut( &mut self, ) -> Option<&mut IndexMap<BorrowedValue<'a>, BorrowedValue<'a>>>

Try to get this value as a mutable mapping

pub fn into_owned(self) -> BorrowedValue<'static>

Convert to an owned Value (for when lifetime constraints require it)

pub fn clone_if_needed(&self) -> Self

Clone only if necessary (for Cow optimization)

Trait Implementations

impl<'a> Clone for BorrowedValue<'a>

fn clone(&self) -> BorrowedValue<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BorrowedValue<'a>

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

Formats the value using the given formatter.

impl<'a> Default for BorrowedValue<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Display for BorrowedValue<'a>

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

Formats the value using the given formatter.

impl From<BorrowedValue<'_>> for Value

fn from(value: BorrowedValue<'_>) -> 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<'a> Hash for BorrowedValue<'a>

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<'a> PartialEq for BorrowedValue<'a>

fn eq(&self, other: &BorrowedValue<'a>) -> 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<'a> Eq for BorrowedValue<'a>

impl<'a> StructuralPartialEq for BorrowedValue<'a>