Enum rustdoc::formats::item_type::ItemType

#[repr(u8)]
pub(crate) enum ItemType {
    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,
    ProcAttribute = 23,
    ProcDerive = 24,
    TraitAlias = 25,
}

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

ProcAttribute = 23

ProcDerive = 24

TraitAlias = 25

Implementations

impl ItemType

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

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

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

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

Trait Implementations

impl Clone for ItemType

fn clone(&self) -> ItemType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ItemType

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

Formats the value using the given formatter.

impl Display for ItemType

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<DefKind> for ItemType

fn from(other: DefKind) -> Self

Converts to this type from the input type.

impl FromWithTcx<ItemType> for ItemKind

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

impl Hash for ItemType

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ItemType

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ItemType

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ItemType

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ItemType

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ItemType

impl Eq for ItemType

impl StructuralPartialEq for ItemType

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
• ProcAttribute: 0 bytes
• ProcDerive: 0 bytes
• TraitAlias: 0 bytes