Enum rustdoc::html::highlight::Class

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

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§

source§

impl Class

source

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.

source

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).

source

fn as_html(self) -> &'static str

Returns the css class expected by rustdoc for each Class.

source

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§

source§

impl Clone for Class

source§

fn clone(&self) -> Class

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Class

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for Class

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for Class

source§

impl Eq for Class

source§

impl StructuralPartialEq for Class

Auto Trait Implementations§

§

impl Freeze for Class

§

impl RefUnwindSafe for Class

§

impl !Send for Class

§

impl !Sync for Class

§

impl Unpin for Class

§

impl UnwindSafe for Class

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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