Struct Context 

pub struct Context { /* private fields */ }

Template rendering context — holds all variables available during rendering.

Examples

From an iterator of tuples:

use md_tmpl_core::{Context, Value};

let ctx: Context = vec![
    ("name", Value::from("Alice")),
    ("count", Value::from(3_i64)),
]
.into_iter()
.collect();

assert!(ctx.get("name").is_some());

Implementations

impl Context

pub fn new() -> Context

Create an empty context.

pub fn with_capacity(capacity: usize) -> Context

Create an empty context pre-allocated for capacity variables.

pub fn len(&self) -> usize

Returns the number of variables in this context.

pub fn is_empty(&self) -> bool

Returns true if this context contains no variables.

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

Returns true if a variable with the given key exists.

pub fn set(&mut self, key: impl Into<String>, value: impl Into<Value>)

Insert a value into the context.

This is the dynamic API — the key is a plain string and type mismatches are caught at render_ctx() time, not here. For compile-time type safety, prefer one of:

• include_template! (from md-tmpl-macros) — generates a strongly-typed parameter struct from your template.
• Template::render (feature serde) — renders directly from any Serialize struct.

Panics

Panics if key is the reserved internal key __kind__ — this key is used internally for enum variant tagging and must not be set directly. Use enum types in the template frontmatter instead.

pub fn var(self, key: impl Into<String>, value: impl Into<Value>) -> Context

Builder-style insert — returns self for chaining.

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

Look up a top-level variable.

pub fn into_inner(self) -> HashMap<String, Value>

Consume this context and return the inner variable map.

Useful for converting a context into a Value::Struct.

impl Context

pub fn from_value(val: Value) -> Result<Context, TemplateError>

Build a Context directly from a Value::Struct.

Errors

Returns TemplateError::Syntax if the value is not a dict/map.

pub fn from_serialize<T>(value: &T) -> Result<Context, TemplateError>

where T: Serialize,

Build a Context from any Serialize type that serializes as a map/struct.

Errors

Returns TemplateError::Syntax if the serialized value is not a dict/map.

impl Context

CBOR support — behind the cbor feature, which implies serde.

Available in no_std — ciborium uses its own Read trait with a blanket impl for &[u8].

pub fn from_cbor(data: &[u8]) -> Result<Context, TemplateError>

Build a Context from a CBOR binary buffer.

Errors

Returns TemplateError::Syntax if the buffer is invalid or not a dict/map.

impl Context

FlexBuffers support — behind the flexbuffers feature, which implies std and serde (the flexbuffers crate does not support no_std).

pub fn from_flexbuffers(data: &[u8]) -> Result<Context, TemplateError>

Build a Context from a FlexBuffers binary buffer.

Errors

Returns TemplateError::Syntax if the buffer is invalid or not a dict/map.

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Context

Returns the “default value” for a type.

impl<K, V> FromIterator<(K, V)> for Context

where K: Into<String>, V: Into<Value>,

Collect (&str, Value) tuples into a Context.

fn from_iter<I>(iter: I) -> Context

where I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator.