Enum rustdoc::clean::types::ItemKind

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

Variants

ExternCrateItem

Fields of ExternCrateItem

src: Option<Symbol>

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

ImportItem(Import)

StructItem(Struct)

UnionItem(Union)

EnumItem(Enum)

FunctionItem(Function)

ModuleItem(Module)

TypedefItem(Typedef, bool)

OpaqueTyItem(OpaqueTy)

StaticItem(Static)

ConstantItem(Constant)

TraitItem(Trait)

TraitAliasItem(TraitAlias)

ImplItem(Impl)

TyMethodItem(Function)

A method signature only. Used for required methods in traits (ie, non-default-methods).

MethodItem(Function, Option<Defaultness>)

A method with a body.

StructFieldItem(Type)

VariantItem(Variant)

ForeignFunctionItem(Function)

fns from an extern block

ForeignStaticItem(Static)

statics from an extern block

ForeignTypeItem

types from an extern block

MacroItem(Macro)

ProcMacroItem(ProcMacro)

PrimitiveItem(PrimitiveType)

AssocConstItem(Type, Option<String>)

AssocTypeItem(Vec<GenericBound>, Option<Type>)

An associated item in a trait or trait impl.

The bounds may be non-empty if there is a where clause. The Option<Type> is the default concrete type (e.g. trait Trait { type Target = usize; })

StrippedItem(Box<ItemKind>)

An item that has been stripped by a rustdoc pass

KeywordItem(Symbol)

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_type_alias(&self) -> bool

Trait Implementations

impl Clone for ItemKind

fn clone(&self) -> ItemKind

Returns a copy of the value.

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