Enum rustdoc::html::highlight::Class

enum Class {
    Comment,
    DocComment,
    Attribute,
    KeyWord,
    RefKeyWord,
    Self_(Span),
    Macro(Span),
    MacroNonTerminal,
    String,
    Number,
    Bool,
    Ident(Span),
    Lifetime,
    PreludeTy,
    PreludeVal,
    QuestionMark,
    Decoration(&'static str),
}

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

Variants

Comment

DocComment

Attribute

KeyWord

RefKeyWord

Keywords that do pointer/reference stuff.

Self_(Span)

Macro(Span)

MacroNonTerminal

String

Number

Bool

Ident(Span)

Ident isn’t rendered in the HTML but we still need it for the Span it contains.

Lifetime

PreludeTy

PreludeVal

QuestionMark

Decoration(&'static str)

Implementations

impl Class

fn is_equal_to(self, other: Self) -> bool

It is only looking at the variant, not the variant content.

It is used mostly to group multiple similar HTML elements into one <span> instead of multiple ones.

fn dummy(self) -> Self

If self contains a Span, it’ll be replaced with DUMMY_SP to prevent creating links on “empty content” (because of the attributes merge).

fn as_html(self) -> &'static str

Returns the css class expected by rustdoc for each Class.

fn get_span(self) -> Option<Span>

In case this is an item which can be converted into a link to a definition, it’ll contain a “span” (a tuple representing (lo, hi) equivalent of Span).

Trait Implementations

impl Clone for Class

fn clone(&self) -> Class

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Class

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Class> for Class

fn eq(&self, other: &Class) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Class

impl Eq for Class

impl StructuralEq for Class

impl StructuralPartialEq for Class

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes

Size for each variant:

• Comment: 0 bytes
• DocComment: 0 bytes
• Attribute: 0 bytes
• KeyWord: 0 bytes
• RefKeyWord: 0 bytes
• Self_: 8 bytes
• Macro: 8 bytes
• MacroNonTerminal: 0 bytes
• String: 0 bytes
• Number: 0 bytes
• Bool: 0 bytes
• Ident: 8 bytes
• Lifetime: 0 bytes
• PreludeTy: 0 bytes
• PreludeVal: 0 bytes
• QuestionMark: 0 bytes
• Decoration: 20 bytes