Struct tfm::ligkern::lang::Instruction

pub struct Instruction {
    pub next_instruction: Option<u8>,
    pub right_char: Char,
    pub operation: Operation,
}

A single instruction in a lig/kern program.

In TFM files, instructions are serialized to 32 bit integers.

In property list files, instructions are specified using a (LIG _ _) or (KERN _ _) element, and optionally a (STOP) or (SKIP _) element directly after.

Fields

next_instruction: Option<u8>

Specifies the next instruction to run if this instruction is not applicable - e.g., if the right character of the pair is not right_char. If the payload is present, that number of lig/kern instructions in the list of all instructions are skipped to find the next instruction. Otherwise this is the final instruction and there are no more instructions to consider.

right_char: Char

This instruction is run if the right character in the pair is this character. Otherwise the next lig kern instruction for the current character is considered, using the next_instruction field.

After this operation is performed, no more operations need to be performed on this pair. However the result of the operation may result in a new pair being created and the lig/kern program will run for that pair. See the documentation on PostLigOperation for information on that.

operation: Operation

The operation to perform for this instruction.

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Instruction

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

Formats the value using the given formatter.

impl PartialEq for Instruction

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

impl StructuralPartialEq for Instruction