Struct rustdoc::html::highlight::Classifier

struct Classifier<'sess> {
    lexer: StringReader<'sess>,
    peek_token: Option<Token>,
    source_map: &'sess SourceMap,
    in_attribute: bool,
    in_macro: bool,
    in_macro_nonterminal: bool,
}

Processes a program (nested in the internal lexer), classifying strings of text by highlighting category (Class). Calls out to a Writer to write each span of text in sequence.

Fields

lexer: StringReader<'sess>

peek_token: Option<Token>

source_map: &'sess SourceMap

in_attribute: bool

in_macro: bool

in_macro_nonterminal: bool

Implementations

impl<'sess> Classifier<'sess>

fn new(sess: &ParseSess, source_file: Lrc<SourceFile>) -> Classifier<'_>

fn try_next_token(&mut self) -> Result<Token, HighlightError>

Gets the next token out of the lexer.

fn peek(&mut self) -> Result<&Token, HighlightError>

fn write_source<W: Writer>(&mut self, out: &mut W) -> Result<(), HighlightError>

Exhausts the lexer writing the output into out.

The general structure for this method is to iterate over each token, possibly giving it an HTML span with a class specifying what flavor of token is used. All source code emission is done as slices from the source map, not from the tokens themselves, in order to stay true to the original source.

fn write_token<W: Writer>(
    &mut self,
    out: &mut W,
    token: Token
) -> Result<(), HighlightError>

fn snip(&self, sp: Span) -> String