Enum rustdoc::formats::item_type::ItemType

source ·
#[repr(u8)]
pub(crate) enum ItemType {
Show 26 variants Keyword = 0, Primitive = 1, Module = 2, ExternCrate = 3, Import = 4, Struct = 5, Enum = 6, Function = 7, TypeAlias = 8, Static = 9, Trait = 10, Impl = 11, TyMethod = 12, Method = 13, StructField = 14, Variant = 15, Macro = 16, AssocType = 17, Constant = 18, AssocConst = 19, Union = 20, ForeignType = 21, OpaqueTy = 22, ProcAttribute = 23, ProcDerive = 24, TraitAlias = 25,
}
Expand description

Item type. Corresponds to clean::ItemEnum variants.

The search index uses item types encoded as smaller numbers which equal to discriminants. JavaScript then is used to decode them into the original value. Consequently, every change to this type should be synchronized to the itemTypes mapping table in html/static/js/search.js.

The search engine in search.js also uses item type numbers as a tie breaker when sorting results. Keywords and primitives are given first because we want them to be easily found by new users who don’t know about advanced features like type filters. The rest are mostly in an arbitrary order, but it’s easier to test the search engine when it’s deterministic, and these are strictly finer-grained than language namespaces, so using the path and the item type together to sort ensures that search sorting is stable.

In addition, code in html::render uses this enum to generate CSS classes, page prefixes, and module headings. If you are adding to this enum and want to ensure that the sidebar also prints a heading, edit the listing in html/render.rs, function sidebar_module. This uses an ordering based on a helper function inside item_module, in the same file.

Variants§

§

Keyword = 0

§

Primitive = 1

§

Module = 2

§

ExternCrate = 3

§

Import = 4

§

Struct = 5

§

Enum = 6

§

Function = 7

§

TypeAlias = 8

§

Static = 9

§

Trait = 10

§

Impl = 11

§

TyMethod = 12

§

Method = 13

§

StructField = 14

§

Variant = 15

§

Macro = 16

§

AssocType = 17

§

Constant = 18

§

AssocConst = 19

§

Union = 20

§

ForeignType = 21

§

OpaqueTy = 22

§

ProcAttribute = 23

§

ProcDerive = 24

§

TraitAlias = 25

Implementations§

source§

impl ItemType

source

pub(crate) fn from_def_kind(kind: DefKind, parent_kind: Option<DefKind>) -> Self

Depending on the parent kind, some variants have a different translation (like a Method becoming a TyMethod).

source

pub(crate) fn as_str(&self) -> &'static str

source

pub(crate) fn is_method(&self) -> bool

source

pub(crate) fn is_adt(&self) -> bool

Trait Implementations§

source§

impl Clone for ItemType

source§

fn clone(&self) -> ItemType

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 ItemType

source§

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

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

impl Display for ItemType

source§

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

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

impl<'a> From<&'a Item> for ItemType

source§

fn from(item: &'a Item) -> ItemType

Converts to this type from the input type.
source§

impl From<DefKind> for ItemType

source§

fn from(other: DefKind) -> Self

Converts to this type from the input type.
source§

impl FromWithTcx<ItemType> for ItemKind

source§

fn from_tcx(kind: ItemType, _tcx: TyCtxt<'_>) -> Self

source§

impl Hash for ItemType

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for ItemType

source§

fn cmp(&self, other: &ItemType) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for ItemType

source§

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

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

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.
source§

impl PartialOrd for ItemType

source§

fn partial_cmp(&self, other: &ItemType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Serialize for ItemType

source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Copy for ItemType

source§

impl Eq for ItemType

source§

impl StructuralPartialEq for ItemType

Auto Trait Implementations§

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
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

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,

§

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> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

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>,

§

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: 1 byte

Size for each variant:

  • Keyword: 0 bytes
  • Primitive: 0 bytes
  • Module: 0 bytes
  • ExternCrate: 0 bytes
  • Import: 0 bytes
  • Struct: 0 bytes
  • Enum: 0 bytes
  • Function: 0 bytes
  • TypeAlias: 0 bytes
  • Static: 0 bytes
  • Trait: 0 bytes
  • Impl: 0 bytes
  • TyMethod: 0 bytes
  • Method: 0 bytes
  • StructField: 0 bytes
  • Variant: 0 bytes
  • Macro: 0 bytes
  • AssocType: 0 bytes
  • Constant: 0 bytes
  • AssocConst: 0 bytes
  • Union: 0 bytes
  • ForeignType: 0 bytes
  • OpaqueTy: 0 bytes
  • ProcAttribute: 0 bytes
  • ProcDerive: 0 bytes
  • TraitAlias: 0 bytes