Trait CharType

Source

pub trait CharType:
    Copy
    + PartialEq
    + Eq
    + Hash
    + Display
    + Debug
    + 'static
    + From<u8>
    + Default {
    type Allchars<A: Default>: AllCharsTrait<Self, A>;

    const MAX: Self;
Show 19 methods
    // Required methods
    fn from_u8_iter(iter: &mut IntoIter<u8>) -> Option<Self>;
    fn from_str(s: &str) -> TeXStr<Self>;
    fn is_eol(self) -> Option<bool>;
    fn is_eol_pair(self, next: Self) -> bool;
    fn par_token() -> TeXStr<Self>;
    fn relax_token() -> TeXStr<Self>;
    fn empty_str() -> TeXStr<Self>;
    fn starting_catcode_scheme() -> CategoryCodeScheme<Self>;
    fn newline() -> Self;
    fn carriage_return() -> Self;
    fn backslash() -> Self;
    fn zeros() -> Self::Allchars<Self>;
    fn ident() -> Self::Allchars<Self>;
    fn rep_field<A: Clone + Default>(a: A) -> Self::Allchars<A>;
    fn char_str(&self) -> String;
    fn as_bytes(&self) -> Vec<u8> ⓘ;
    fn from_i64(i: i64) -> Option<Self>;
    fn to_usize(self) -> usize;

    // Provided method
    fn display_str(str: &TeXStr<Self>, f: &mut Formatter<'_>) -> Result { ... }
}

Expand description

Plain TeX parses source files as a sequence of u8s, but other engines might use bigger types, e.g. XeTeX. This trait allows us to abstract over the character type, by providing the relevant data needed to treat them (essentially) like u8s.

Required Associated Constants§

Source

const MAX: Self

The maximum value of the character type. For u8, this is 255.

Required Associated Types§

Source

type Allchars<A: Default>: AllCharsTrait<Self, A>

The type of the array/vec/whatever of all possible characters. For u8, this is [A;256].

Required Methods§

Source

fn from_u8_iter(iter: &mut IntoIter<u8>) -> Option<Self>

Parses a character from a byte iterator. For u8, this is just iter.next().

Source

fn from_str(s: &str) -> TeXStr<Self>

Convert a &str into a TeXStr<Self>.

Source

fn is_eol(self) -> Option<bool>

Whether the character is an end-of-line character.

Should return:

Some(true): is end of line (e.g. \n).
Some(false): is not end of line.
None: might be, depending on the next character - e.g. \r, in which case the next character should be checked to be \n.

Source

fn is_eol_pair(self, next: Self) -> bool

Should return:

true: if the pair (self,next) represents an end of line (e.g. \r\n).
false: if not; in which case self itself is considered to be an end of line (e.g. \r).

Source