Enum Value 

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

A dynamic metadata value. Integers and floats are kept distinct, and mappings preserve key order (frontmatter is order-significant to humans).

Variants

Null

Null (~, null), and the Default.

Bool(bool)

Boolean.

Int(i64)

Integer.

Float(f64)

Float.

String(String)

String.

Sequence(Vec<Value>)

Sequence (- item).

Mapping(Mapping)

Mapping (key: value), key order preserved.

Implementations

impl Value

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

The string, if this is a Value::String.

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

The boolean, if this is a Value::Bool.

pub fn as_sequence(&self) -> Option<&[Value]>

The sequence, if this is a Value::Sequence.

pub fn as_mapping(&self) -> Option<&Mapping>

The mapping, if this is a Value::Mapping.

pub fn is_null(&self) -> bool

true if this is Value::Null.

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

Look up a key, if this is a mapping.

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

Look up a field path — title, generated.how for a key inside a mapping, sources[2].resource for a key inside one item of a list — and return the first value it reaches. This is how a fields declaration names what it governs (see crate::field); a dot is always a separator, as it is for prov get. A path with a [] step reaches every item, and this returns the first — a caller that wants them all walks field::values_at. None when the path lands on nothing.

pub fn link_strings(&self) -> Vec<String>

Interpret this value as a list of link strings: a bare string yields one element, a sequence yields its string-shaped elements, anything else yields nothing. This is how a relation field (single or multi) is read.

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

fn default() -> Value

Returns the “default value” for a type.

impl From<&Value> for Value

fn from(value: &Value) -> Self

Converts to this type from the input type.

impl From<Value> for Value

fn from(value: Value) -> Self

Converts to this type from the input type.

impl Navigate for Value

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

The value under key, if this is a mapping holding it.

fn items(&self) -> Option<&[Self]>

The items, if this is a list.

fn text(&self) -> Option<&str>

The text, if this is a string.

impl PartialEq for Value

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Value