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§

§

Enum rustdoc::formats::item_type::ItemTypeCopy item path

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§

impl ItemType

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

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

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

impl Debug for ItemType

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

impl Display for ItemType

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

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

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

impl From<DefKind> for ItemType

fn from(other: DefKind) -> Self

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)

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

impl Ord for ItemType

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

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

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

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

impl PartialEq for ItemType

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

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

impl PartialOrd for ItemType

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

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

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

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

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

impl Serialize for ItemType

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

impl Copy for ItemType

impl Eq for ItemType

impl StructuralPartialEq for ItemType

Auto Trait Implementations§

impl Freeze for ItemType

impl RefUnwindSafe for ItemType

impl Send for ItemType

impl Sync for ItemType

impl Unpin for ItemType

impl UnwindSafe for ItemType

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Enum rustdoc::formats::item_type::ItemType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

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

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

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