Enum Value

Source

pub enum Value {
    Str(String),
    Bool(bool),
    Int(i64),
    Float(f64),
    List(Arc<Vec<Value>>),
    Struct(Arc<HashMap<String, Value>>),
    Tmpl(Arc<Template>),
    None,
}

Expand description

A value that can be inserted into a template.

Variants§

§

Str(String)

A plain string.

§

Bool(bool)

A boolean.

§

Int(i64)

A 64-bit integer.

§

Float(f64)

A 64-bit float.

§

List(Arc<Vec<Value>>)

An ordered list of values.

§

Struct(Arc<HashMap<String, Value>>)

A string-keyed map of values.

§

Tmpl(Arc<Template>)

A pre-compiled template.

§

None

An absent/null value — transparent representation of Option::None.

Implementations§

Source §

impl Value

Source

pub fn is_truthy(&self) -> bool

Returns true if the value is considered “truthy”.

Source

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

Returns the type name as a static string.

Source

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

Access a field on a Struct value.

The internal enum tag key (ENUM_TAG_KEY) is hidden — use str(value) to extract the variant name instead.

Source

pub fn is_str(&self) -> bool

Returns true if this is a Str variant.

Source

pub fn is_int(&self) -> bool

Returns true if this is an Int variant.

Source

pub fn is_float(&self) -> bool

Returns true if this is a Float variant.

Source

pub fn is_bool(&self) -> bool

Returns true if this is a Bool variant.

Source

pub fn is_list(&self) -> bool

Returns true if this is a List variant.

Source

pub fn is_struct(&self) -> bool

Returns true if this is a Struct variant.

Source

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

Returns the inner &str if this is a Str variant.

Source

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

Returns the inner i64 if this is an Int variant.

Source

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

Returns the inner f64 if this is a Float variant.

Source

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

Returns the inner bool if this is a Bool variant.

Source

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

Returns a slice of the inner list if this is a List variant.

Source

pub fn as_struct(&self) -> Option<&HashMap<String, Value>>

Returns a reference to the inner map if this is a Struct variant.

Source

pub fn as_tmpl(&self) -> Option<&Arc<Template>>

Returns a reference to the inner template if this is a Tmpl variant.

Source

pub fn new_struct<I, K, V>(pairs: I) -> Value
where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<Value>,

Create a Struct from an iterator of key-value pairs.

Accepts arrays, slices, vecs — anything iterable.

§Examples

use md_tmpl_core::Value;

let v = Value::new_struct([("name", "Alice"), ("role", "admin")]);
assert_eq!(v.get_field("name").unwrap().to_string(), "Alice");

Source

pub fn list<I, V>(items: I) -> Value
where I: IntoIterator<Item = V>, V: Into<Value>,

Create a List from an iterator of values.

Accepts arrays, slices, vecs — anything iterable.

§Examples

use md_tmpl_core::Value;

let v = Value::list([
    Value::new_struct([("label", "alpha")]),
    Value::new_struct([("label", "beta")]),
]);
assert_eq!(v.type_name(), "list");

Source §

impl Value

Source

pub fn from_serialize<T>(value: &T) -> Result<Value, SerError>
where T: Serialize,

Create a Value from any Serialize type.

This is the same as to_value but available as a method on Value for convenience.

§Errors

Returns an error if serialization fails.

§Examples

use md_tmpl_core::Value;
use serde::Serialize;

#[derive(Serialize)]
struct Agent {
    name: String,
}

let val = Value::from_serialize(&Agent {
    name: "Alice".into(),
})
.unwrap();
assert_eq!(val.get_field("name").unwrap().as_str(), Some("Alice"));

Source

pub fn deserialize_into<'de, T>(&'de self) -> Result<T, DeError>
where T: Deserialize<'de>,

Deserialize this Value into a Rust type.

This is the same as from_value but available as a method on Value for convenience.

§Errors

Returns an error if the value shape doesn’t match T.

§Examples

use md_tmpl_core::Value;
use serde::Deserialize;

#[derive(Deserialize, Debug, PartialEq)]
struct Agent {
    name: String,
}

let val = Value::new_struct([("name", Value::Str("Alice".into()))]);
let agent: Agent = val.deserialize_into().unwrap();
assert_eq!(
    agent,
    Agent {
        name: "Alice".into()
    }
);