Struct synoptic::highlighter::Highlighter

pub struct Highlighter {
    pub regex: HashMap<&'static str, Vec<Regex>>,
    pub multiline_regex: HashMap<&'static str, Vec<Regex>>,
}

For performing highlighting operations You can create a new Highlighter instance using the new method

let mut h = Highlighter::new();

Fields

regex: HashMap<&'static str, Vec<Regex>>

multiline_regex: HashMap<&'static str, Vec<Regex>>

Implementations

impl Highlighter

#[must_use]pub fn new() -> Self

This will create a new, blank highlighter instance

pub fn join(
    &mut self,
    regex: &[&'static str],
    token: &'static str
) -> Result<(), ReError>

This method allows you to add multiple definitions to the highlighter The first argument is for your list of definitions and the second is for the name This is useful for adding lists of keywords, for example:

let mut python = Highlighter::new();
python.join(&["def", "return", "import"], "keyword");

For multiline tokens, you can add (?ms) or (?sm) to the beginning

Errors

This will return an error if one or more of your regex expressions are invalid

pub fn add(
    &mut self,
    regex: &'static str,
    token: &'static str
) -> Result<(), ReError>

This method allows you to add a single definition to the highlighter The first argument is for your definition and the second is for the name This is useful for adding things like regular expressions, for example:

let mut python = Highlighter::new();
python.add("[0-9]+", "number");

For multiline tokens, you can add (?ms) or (?sm) to the beginning

Errors

This will return an error if your regex is invalid

pub fn run(&mut self, code: &'static str) -> Vec<Vec<Token>>

This is the method that you call to get the stream of tokens The argument is the string with the code that you wish to highlight This will return a vector of a vector of tokens, representing the lines and the tokens in them

let mut python = Highlighter::new();
python.add("[0-9]+", "number");
python.run("some numbers: 123");

This example will highlight the numbers 123 in the string

Trait Implementations

impl Default for Highlighter

pub fn default() -> Self

Returns the "default value" for a type.