Enum RegisterValue 

pub enum RegisterValue {
    Number(Number),
    Dimension(Dimension),
    MuDimension(MuDimension),
    Glue(Glue),
    MuGlue(MuGlue),
    Token(Token),
    Tokens(Tokens),
    Pair(Pair),
}

The values that can be read by, and stored in, a Register

Variants

Number(Number)

A unitless number

Dimension(Dimension)

A dimension with associated unit

MuDimension(MuDimension)

A “mu” dimension with associated unit

Glue(Glue)

A Glue space

MuGlue(MuGlue)

A Mu Glue space

Token(Token)

used by token registers

Tokens(Tokens)

used by token registers

Pair(Pair)

A coordinate pair (x,y) — used by picture environment

Implementations

impl RegisterValue

pub fn coerce_to(self, rtype: RegisterType) -> RegisterValue

Coerce a numeric value to the requested register type, preserving the raw scaled value. eTeX \dimexpr/\numexpr/\glueexpr/\muexpr fix the result type by the command, not by the operands — but our expression evaluator’s “missing number, treated as zero” recovery and LHS-typed arithmetic can return e.g. Number(0) for a \dimexpr (Dimension) request, which then panics the register getter’s expect_dimension() (witness: \dimexpr inside a pgf-calc coordinate — arXiv 2302.02182 and ~8 siblings in the large-scale canvas crashed here). Coercing the final value to rtype keeps the getter total. Non-numeric values (Token/Tokens/ Pair) and already-matching types pass through unchanged.

Trait Implementations

impl Clone for RegisterValue

fn clone(&self) -> RegisterValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegisterValue

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

Formats the value using the given formatter.

impl Default for RegisterValue

fn default() -> Self

Returns the “default value” for a type.

impl Display for RegisterValue

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

Formats the value using the given formatter.

impl From<&RegisterValue> for RegisterType

fn from(v: &RegisterValue) -> RegisterType

Converts to this type from the input type.

impl From<&RegisterValue> for Number

fn from(v: &RegisterValue) -> Number

Converts to this type from the input type.

impl From<&RegisterValue> for Dimension

fn from(v: &RegisterValue) -> Dimension

Converts to this type from the input type.

impl From<&RegisterValue> for Glue

fn from(v: &RegisterValue) -> Glue

Converts to this type from the input type.

impl From<&RegisterValue> for MuGlue

fn from(v: &RegisterValue) -> MuGlue

Converts to this type from the input type.

impl From<Dimension> for RegisterValue

fn from(n: Dimension) -> RegisterValue

Converts to this type from the input type.

impl From<Glue> for RegisterValue

fn from(n: Glue) -> RegisterValue

Converts to this type from the input type.

impl From<MuDimension> for RegisterValue

fn from(n: MuDimension) -> RegisterValue

Converts to this type from the input type.

impl From<MuGlue> for RegisterValue

fn from(n: MuGlue) -> RegisterValue

Converts to this type from the input type.

impl From<Number> for RegisterValue

fn from(n: Number) -> RegisterValue

Converts to this type from the input type.

impl From<Pair> for RegisterValue

fn from(p: Pair) -> RegisterValue

Converts to this type from the input type.

impl From<RegisterValue> for Stored

fn from(rv: RegisterValue) -> Self

Converts to this type from the input type.

impl From<RegisterValue> for ArgWrap

fn from(t: RegisterValue) -> Self

Converts to this type from the input type.

impl From<RegisterValue> for Number

fn from(v: RegisterValue) -> Number

Converts to this type from the input type.

impl From<RegisterValue> for Dimension

fn from(v: RegisterValue) -> Dimension

Converts to this type from the input type.

impl From<RegisterValue> for Glue

fn from(v: RegisterValue) -> Glue

Converts to this type from the input type.

impl From<RegisterValue> for MuGlue

fn from(v: RegisterValue) -> MuGlue

Converts to this type from the input type.

impl From<RegisterValue> for f64

fn from(v: RegisterValue) -> f64

Converts to this type from the input type.

impl From<RegisterValue> for i64

fn from(v: RegisterValue) -> i64

Converts to this type from the input type.

impl From<RegisterValue> for Tokens

fn from(v: RegisterValue) -> Tokens

Converts to this type from the input type.

impl From<RegisterValue> for Digested

fn from(value: RegisterValue) -> Digested

Converts to this type from the input type.

impl From<Token> for RegisterValue

fn from(n: Token) -> RegisterValue

Converts to this type from the input type.

impl From<Tokens> for RegisterValue

fn from(n: Tokens) -> RegisterValue

Converts to this type from the input type.

impl IntoDigestedOptionResult<Result<Option<Digested>, Error>> for RegisterValue

fn into_digested_option_result(self) -> Result<Option<Digested>>

impl NumericOps for RegisterValue

fn into_glue_type(self) -> Glue

For now only meant as a type cast, unimplemented in other cases DO NOT use this method to cast into a Glue object, define a .to_glue() instead

fn new(number: i64) -> Self

fn new_f64(number: f64) -> Self

fn value_of(self) -> i64

fn register_type(&self) -> RegisterType

fn add<T: NumericOps>(self, other: T) -> Self

fn subtract<T: NumericOps>(self, other: T) -> Self

fn multiply<T: NumericOps>(self, other: T) -> Self

fn negate(self) -> Self

fn divide<T: NumericOps>(self, other: T) -> Self

where Self: Sized,

Truncating division

fn smaller<T: NumericOps>(self, other: T) -> Self

where Self: Sized,

fn larger<T: NumericOps>(self, other: T) -> Self

where Self: Sized,

fn to_attribute(&self) -> String

where Self: Display,

fn unit(&self) -> Option<&'static str>

fn value_f64(self) -> f64

where Self: Sized,

fn pt_value(self, prec: Option<u8>) -> f64

where Self: Sized,

fn px_value(self, prec: Option<u8>) -> f64

where Self: Sized,

fn absolute(self) -> Self

where Self: Sized,

fn sign(self) -> i8

where Self: Sized,

fn divideround<T: NumericOps>(self, other: T) -> Self

where Self: Sized,

Rounding division

fn to_token(self) -> Token

where Self: Sized,

impl Object for RegisterValue

fn stringify(&self) -> String

fn revert(&self) -> Result<Tokens>

each concrete object needs to provide its own path back to tokens

fn isa_box(&self) -> bool

fn is_expandable(&self) -> bool

fn is_definition(&self) -> bool

fn is_comment(&self) -> bool

fn be_digested(self) -> Result<Digested>

where Self: Sized + Debug,

fn get_locator(&self) -> Option<Locator>

The object’s stored source locator, if it has one. None is the honest “no recorded source position” (replacing the old Locator::default() file!()/line!() sentinel). For “where the parser is now” (error reporting, box creation), use the free fn gullet::get_locator().

impl PartialEq for RegisterValue

fn eq(&self, other: &RegisterValue) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RegisterValue