Module rustdoc::html::highlight

Basic syntax highlighting functionality.

This module uses librustc_ast’s lexer to provide token-based highlighting for the HTML documentation generated by rustdoc.

Use the render_with_highlighting to highlight some rust code.

Structs

Classifier

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

ContextInfo

This type is needed in case we want to render links on items to allow to go to their definition.

PeekIter

This iterator comes from the same idea than “Peekable” except that it allows to “peek” more than just the next item by using peek_next. The peek method always returns the next item after the current one whereas peek_next will return the next item after the last one peeked.

TokenIter

Enums

Class

How a span of text is classified. Mostly corresponds to token kinds.

Highlight

Functions

enter_span

Called when we start processing a span of text that should be highlighted. The Class argument specifies how it should be highlighted.

exit_span

Called at the end of a span of highlighted text.

get_real_ident_class

Classifies into identifier class; returns None if this is a non-keyword identifier.

render_with_highlighting

Highlights src, returning the HTML output.

string

Called for a span of text. If the text should be highlighted differently from the surrounding text, then the Class argument will be a value other than None.

write_code

Convert the given src source code into HTML by adding classes for highlighting.

write_footer

write_header