Struct Highlighter

pub struct Highlighter {
    pub parser: Parser,
    /* private fields */
}

Performs syntax highlighting, recognizing a given list of highlight names.

For the best performance Highlighter values should be reused between syntax highlighting calls. A separate highlighter is needed for each thread that is performing highlighting.

Fields

parser: Parser

Implementations

impl Highlighter

pub fn new() -> Self

pub fn parser(&mut self) -> &mut Parser

pub fn highlight<'a>( &'a mut self, config: &'a HighlightConfiguration, source: &'a [u8], cancellation_flag: Option<&'a AtomicUsize>, injection_callback: impl FnMut(&str) -> Option<&'a HighlightConfiguration> + 'a, ) -> Result<impl Iterator<Item = Result<HighlightEvent, Error>> + 'a, Error>

Iterate over the highlighted regions for a given slice of source code.

Trait Implementations

impl Default for Highlighter

fn default() -> Self

Returns the “default value” for a type.