Struct State 

pub struct State { /* private fields */ }

Manages stateful parts of your document.

Implementations

impl State

pub fn new(key: Str, init: Value) -> State

Create a new state identified by a key.

pub fn select(&self) -> Selector

The selector for this state’s updates.

pub fn select_any() -> Selector

Selects all state updates.

impl State

pub fn construct(key: Str, init: Value) -> State

Create a new state identified by a key.

pub fn get( &self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, span: Span, ) -> SourceResult<Value>

Retrieves the value of the state at the current location.

pub fn at( &self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, span: Span, selector: LocatableSelector, ) -> SourceResult<Value>

Retrieves the value of the state at the given selector’s unique match.

pub fn final_( &self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, span: Span, ) -> SourceResult<Value>

Retrieves the value of the state at the end of the document.

pub fn update(self, span: Span, update: StateUpdate) -> Content

Updates the value of the state.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl FromValue for State

fn from_value(value: Value) -> HintedStrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for State

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 IntoValue for State

fn into_value(self) -> Value

Cast this type into a value.

impl NativeScope for State

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl NativeType for State

const NAME: &'static str = "state"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl PartialEq for State

fn eq(&self, other: &State) -> 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 Reflect for State

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for State

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl StructuralPartialEq for State