Enum rustdoc::formats::item_type::ItemType

pub(crate) enum ItemType {
    Module,
    ExternCrate,
    Import,
    Struct,
    Enum,
    Function,
    Typedef,
    Static,
    Trait,
    Impl,
    TyMethod,
    Method,
    StructField,
    Variant,
    Macro,
    Primitive,
    AssocType,
    Constant,
    AssocConst,
    Union,
    ForeignType,
    Keyword,
    OpaqueTy,
    ProcAttribute,
    ProcDerive,
    TraitAlias,
}

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/main.js.

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

Module

ExternCrate

Import

Struct

Enum

Function

Typedef

Static

Trait

Impl

TyMethod

Method

StructField

Variant

Macro

Primitive

AssocType

Constant

AssocConst

Union

ForeignType

Keyword

OpaqueTy

ProcAttribute

ProcDerive

TraitAlias

Implementations

impl ItemType

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

Trait Implementations

impl Clone for ItemType

pub fn clone(&self) -> ItemType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ItemType

impl Debug for ItemType

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

Formats the value using the given formatter.

impl Display for ItemType

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

Formats the value using the given formatter.

impl Eq for ItemType

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

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

Performs the conversion.

impl From<TypeKind> for ItemType

pub fn from(kind: TypeKind) -> ItemType

Performs the conversion.

impl Ord for ItemType

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ItemType> for ItemType

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ItemType> for ItemType

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl Serialize for ItemType

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

Serialize this value into the given Serde serializer.

impl StructuralEq for ItemType

impl StructuralPartialEq for ItemType