Enum CategoryCode 

pub enum CategoryCode {
    Escape = 0,
    BeginGroup = 1,
    EndGroup = 2,
    MathShift = 3,
    AlignmentTab = 4,
    EOL = 5,
    Parameter = 6,
    Superscript = 7,
    Subscript = 8,
    Ignored = 9,
    Space = 10,
    Letter = 11,
    Other = 12,
    Active = 13,
    Comment = 14,
    Invalid = 15,
}

The category code of a character.

To convert between CategoryCodes and their numerical values (as u8), use CategoryCode::try_from and u8::from, respectively.

Example

use tex_engine::tex::catcodes::CategoryCode;

let cat = CategoryCode::BeginGroup;
let num : u8 = cat.into();
assert_eq!(num,1);
let cat2 = CategoryCode::try_from(1).unwrap();
assert_eq!(cat2,cat);

Variants

Escape = 0

Escape character (0); usually \

BeginGroup = 1

Begin group character (1); usually {

EndGroup = 2

End group character (2); usually }

MathShift = 3

Math shift character (3); usually $

AlignmentTab = 4

Alignment tab character (4); usually &

EOL = 5

End of line character (5); usually \n

Parameter = 6

Parameter character (6); usually #

Superscript = 7

Superscript character (7); usually ^

Subscript = 8

Subscript character (8); usually _

Ignored = 9

Ignored character (9)

Space = 10

Space character (10); usually

Letter = 11

Letter character (11), usually a-z and A-Z

Other = 12

Other character (12), usually e.g. @, !, ?, etc.

Active = 13

Active character (13); usually ~

Comment = 14

Comment character (14); usually %

Invalid = 15

Invalid character (15)

Trait Implementations

impl Clone for CategoryCode

fn clone(&self) -> CategoryCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CategoryCode

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

Formats the value using the given formatter.

impl Default for CategoryCode

fn default() -> CategoryCode

Returns the “default value” for a type.

impl Display for CategoryCode

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

Formats the value using the given formatter.

impl From<CategoryCode> for CommandCode

fn from(value: CategoryCode) -> Self

Converts to this type from the input type.

impl From<CategoryCode> for u8

fn from(cc: CategoryCode) -> Self

Converts to this type from the input type.

impl PartialEq for CategoryCode

fn eq(&self, other: &CategoryCode) -> 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 TryFrom<u8> for CategoryCode

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for CategoryCode

impl Eq for CategoryCode

impl StructuralPartialEq for CategoryCode