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

A TeX variable of a specific Rust type T.

Implementations§

source§

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

source

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

Returns an immutable reference to the variable’s value.

source§

impl<S, T> TypedVariable<S, T>where S: TexlangState, T: SupportedType,

source

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§

source§

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

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

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

source§

fn eq(&self, rhs: &TypedVariable<S, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

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

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.