Module 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

ClassInfo 🔒

ClassStack 🔒

This represents the stack of HTML elements. For example a macro expansion will contain other elements which might themselves contain other elements (like macros).

Classifier 🔒

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

DecorationInfo 🔒

Decorations are represented as a map from CSS class to vector of character ranges. Each range will be wrapped in a span with that class.

Decorations 🔒

Custom spans inserted into the source. Eg –scrape-examples uses this to highlight function calls

HrefContext 🔒

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

LineInfo 🔒

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.

TokenHandler 🔒

This type is used as a conveniency to prevent having to pass all its fields as arguments into the various functions (which became its methods).

TokenIter 🔒

Enums

Class 🔒

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

Highlight 🔒

LineNumberKind 🔒

Represents the type of line number to be generated as HTML.

Tooltip 🔒

Constants

NON_MACRO_KEYWORDS 🔒

Used to know if a keyword followed by a ! should never be treated as a macro.

Functions

can_merge 🔒

Check if two Class can be merged together. In the following rules, “unclassified” means None basically (since it’s Option<Class>). The following rules apply:

classify 🔒

end_expansion 🔒

generate_link_to_def 🔒

get_expansion 🔒

get_next_expansion 🔒

is_keyword 🔒

new_span 🔒

Convenient wrapper to create a Span from a position in the file.

render_example_with_highlighting 🔒

Highlights src as an inline example, returning the HTML output.

string_without_closing_tag 🔒

This function writes text into out with some modifications depending on klass:

write_code 🔒

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

write_footer 🔒

write_header 🔒