Struct rustdoc::html::highlight::Classifier

struct Classifier<'a> {
    tokens: Peekable<TokenIter<'a>>,
    in_attribute: bool,
    in_macro: bool,
    in_macro_nonterminal: bool,
    edition: Edition,
    byte_pos: u32,
    src: &'a str,
}

Processes program tokens, classifying strings of text by highlighting category (Class).

Fields

tokens: Peekable<TokenIter<'a>>

in_attribute: bool

in_macro: bool

in_macro_nonterminal: bool

edition: Edition

byte_pos: u32

src: &'a str

Implementations

impl<'a> Classifier<'a>

fn new(src: &str, edition: Edition) -> Classifier<'_>

fn get_full_ident_path(&mut self) -> Vec<(TokenKind, usize, usize)>

Concatenate colons and idents as one when possible.

fn next(&mut self) -> Option<(TokenKind, &'a str)>

Wraps the tokens iteration to ensure that the byte_pos is always correct.

fn highlight(self, sink: &mut dyn FnMut(Highlight<'a>))

Exhausts the Classifier writing the output into sink.

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.

fn advance(
    &mut self,
    token: TokenKind,
    text: &'a str,
    sink: &mut dyn FnMut(Highlight<'a>)
)

Single step of highlighting. This will classify token, but maybe also a couple of following ones as well.

fn peek(&mut self) -> Option<TokenKind>