Struct texlang::variable::TypedVariable

pub struct TypedVariable<S, T>(/* private fields */);

A TeX variable of a specific Rust type T.

Implementations

impl<S, T> TypedVariable<S, T>

pub fn get<'a>(&self, state: &'a S) -> &'a T

Returns an immutable reference to the variable’s value.

impl<S, T> TypedVariable<S, T>

where S: TexlangState, T: SupportedType,

pub fn set(&self, input: &mut ExecutionInput<S>, scope: Scope, value: T)

Sets the value of the variable.

The input and scope must be passed because of TeX’s grouping semantics. When the current group ends, any variable assignments made in the group are rolled back. Thus this function generally saves the current value of the variable in the VM so that it can be restored later. This is why the full input must be provided, and not just the state.

Trait Implementations

impl<S, T> Clone for TypedVariable<S, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S, T> Hash for TypedVariable<S, T>

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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<S, T> PartialEq for TypedVariable<S, T>

fn eq(&self, rhs: &TypedVariable<S, T>) -> 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<S, T> Copy for TypedVariable<S, T>

impl<S, T> Eq for TypedVariable<S, T>