Enum rustdoc::clean::types::ItemKind

pub(crate) enum ItemKind {
    ExternCrateItem {
        src: Option<Symbol>,
    },
    ImportItem(Import),
    StructItem(Struct),
    UnionItem(Union),
    EnumItem(Enum),
    FunctionItem(Box<Function>),
    ModuleItem(Module),
    TypeAliasItem(Box<TypeAlias>),
    StaticItem(Static),
    TraitItem(Box<Trait>),
    TraitAliasItem(TraitAlias),
    ImplItem(Box<Impl>),
    TyMethodItem(Box<Function>),
    MethodItem(Box<Function>, Option<Defaultness>),
    StructFieldItem(Type),
    VariantItem(Variant),
    ForeignFunctionItem(Box<Function>, Safety),
    ForeignStaticItem(Static, Safety),
    ForeignTypeItem,
    MacroItem(Macro),
    ProcMacroItem(ProcMacro),
    PrimitiveItem(PrimitiveType),
    TyAssocConstItem(Generics, Box<Type>),
    ConstantItem(Box<Constant>),
    AssocConstItem(Box<Constant>),
    TyAssocTypeItem(Generics, Vec<GenericBound>),
    AssocTypeItem(Box<TypeAlias>, Vec<GenericBound>),
    StrippedItem(Box<ItemKind>),
    KeywordItem,
}

Variants

ExternCrateItem

Fields

src: Option<Symbol>

The crate’s name, not the name it’s imported as.

ImportItem(Import)

StructItem(Struct)

UnionItem(Union)

EnumItem(Enum)

FunctionItem(Box<Function>)

ModuleItem(Module)

TypeAliasItem(Box<TypeAlias>)

StaticItem(Static)

TraitItem(Box<Trait>)

TraitAliasItem(TraitAlias)

ImplItem(Box<Impl>)

TyMethodItem(Box<Function>)

A required method in a trait declaration meaning it’s only a function signature.

MethodItem(Box<Function>, Option<Defaultness>)

A method in a trait impl or a provided method in a trait declaration.

Compared to TyMethodItem, it also contains a method body.

StructFieldItem(Type)

VariantItem(Variant)

ForeignFunctionItem(Box<Function>, Safety)

fns from an extern block

ForeignStaticItem(Static, Safety)

statics from an extern block

ForeignTypeItem

types from an extern block

MacroItem(Macro)

ProcMacroItem(ProcMacro)

PrimitiveItem(PrimitiveType)

TyAssocConstItem(Generics, Box<Type>)

A required associated constant in a trait declaration.

ConstantItem(Box<Constant>)

AssocConstItem(Box<Constant>)

An associated constant in a trait impl or a provided one in a trait declaration.

TyAssocTypeItem(Generics, Vec<GenericBound>)

A required associated type in a trait declaration.

The bounds may be non-empty if there is a where clause.

AssocTypeItem(Box<TypeAlias>, Vec<GenericBound>)

An associated type in a trait impl or a provided one in a trait declaration.

StrippedItem(Box<ItemKind>)

An item that has been stripped by a rustdoc pass

KeywordItem

Implementations

impl ItemKind

pub(crate) fn inner_items(&self) -> impl Iterator<Item = &Item>

Some items contain others such as structs (for their fields) and Enums (for their variants). This method returns those contained items.

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

Returns true if this item does not appear inside an impl block.

Trait Implementations

impl Clone for ItemKind

fn clone(&self) -> ItemKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ItemKind

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

Formats the value using the given formatter.

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: 48 bytes

Size for each variant:

• ExternCrateItem: 7 bytes
• ImportItem: 47 bytes
• StructItem: 39 bytes
• UnionItem: 47 bytes
• EnumItem: 47 bytes
• FunctionItem: 15 bytes
• ModuleItem: 39 bytes
• TypeAliasItem: 15 bytes
• StaticItem: 31 bytes
• TraitItem: 15 bytes
• TraitAliasItem: 47 bytes
• ImplItem: 15 bytes
• TyMethodItem: 15 bytes
• MethodItem: 15 bytes
• StructFieldItem: 39 bytes
• VariantItem: 39 bytes
• ForeignFunctionItem: 15 bytes
• ForeignStaticItem: 31 bytes
• ForeignTypeItem: 0 bytes
• MacroItem: 31 bytes
• ProcMacroItem: 39 bytes
• PrimitiveItem: 1 byte
• TyAssocConstItem: 31 bytes
• ConstantItem: 15 bytes
• AssocConstItem: 15 bytes
• TyAssocTypeItem: 47 bytes
• AssocTypeItem: 39 bytes
• StrippedItem: 15 bytes
• KeywordItem: 0 bytes