Struct minijinja_stack_ref::StackHandle

pub struct StackHandle<T: ?Sized> { /* private fields */ }

A handle to an enclosed value.

For as long as the Scope is still valid access to the reference can be temporarily fetched via the with method. Doing so after the scope is gone, this will panic on all operations.

To check if a handle is still valid is_valid can be used.

A stack handle implements the underlying object protocols from MiniJinja.

Implementations

impl<T: ?Sized> StackHandle<T>

pub fn is_valid(handle: &StackHandle<T>) -> bool

Checks if the handle is still valid.

pub fn with<F: FnOnce(&T) -> R, R>(&self, f: F) -> R

Invokes a function with the resolved reference.

Panics

This method panics if the handle is not valid.

Trait Implementations

impl<T: Object + ?Sized> Debug for StackHandle<T>

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

Formats the value using the given formatter.

impl<T: Object + ?Sized> Display for StackHandle<T>

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

Formats the value using the given formatter.

impl<T: Object + ?Sized> Object for StackHandle<T>

fn kind(&self) -> ObjectKind<'_>

Describes the kind of an object.

fn call_method(
    &self,
    state: &State<'_, '_>,
    name: &str,
    args: &[Value]
) -> Result<Value, Error>

Called when the engine tries to call a method on the object.

fn call(&self, state: &State<'_, '_>, args: &[Value]) -> Result<Value, Error>

Called when the object is invoked directly.

impl<T: SeqObject + Send + Sync + 'static + ?Sized> SeqObject for StackHandle<T>

fn get_item(&self, idx: usize) -> Option<Value>

Looks up an item by index.

fn item_count(&self) -> usize

Returns the number of items in the sequence.

impl<T: StructObject + Send + Sync + 'static + ?Sized> StructObject for StackHandle<T>

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

Invoked by the engine to get a field of a struct.

fn static_fields(&self) -> Option<&'static [&'static str]>

If possible returns a static vector of field names.

fn fields(&self) -> Vec<Arc<String>>

Returns a vector of field names.

fn field_count(&self) -> usize

Returns the number of fields.

impl<T: Send + ?Sized> Send for StackHandle<T>

impl<T: Sync + ?Sized> Sync for StackHandle<T>