Enum TokOpt

pub enum TokOpt {
    Some(String, String),
    None(String),
}

This is an enum for representing tokens.

Variants

Some(String, String)

The Some variant represents a token being present in the format Some(TEXT, NAME).

So for a comment token, you can expect to see Some(“/* comment */”, “comment”) provided that you defined the comment using either the keyword or bounded function on Highlighter

None(String)

The None variant represents just plain text.

Implementations

impl TokOpt

pub fn is_empty(&self) -> bool

Works out if this token is empty, and thus redundant

pub fn text(&self) -> &String

Finds the text of a tokopt

pub fn text_mut(&mut self) -> &mut String

Finds the text of a tokopt (mutable)

pub fn nibble_front(&mut self, tab_width: usize) -> Option<char>

This will remove the first character from the end of this token

pub fn nibble_back(&mut self, tab_width: usize) -> Option<char>

This will remove the last character from the end of this token

pub fn skip(&mut self, idx: usize, tab_width: usize)

pub fn take(&mut self, idx: usize, tab_width: usize)

Trait Implementations

impl Clone for TokOpt

fn clone(&self) -> TokOpt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TokOpt

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

Formats the value using the given formatter.