Enum rustdoc::clean::types::ItemKind[−][src]

pub(crate) enum ItemKind {

Show 28 variants    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<ConstantKind>),
    AssocTypeItem(Vec<GenericBound>, Option<Type>),
    StrippedItem(Box<ItemKind>),
    KeywordItem(Symbol),

}

Variants

ExternCrateItem

Fields

src: Option<Symbol>

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

ImportItem(Import)

Tuple Fields

0: Import

StructItem(Struct)

Tuple Fields

0: Struct

UnionItem(Union)

Tuple Fields

0: Union

EnumItem(Enum)

Tuple Fields

0: Enum

FunctionItem(Function)

Tuple Fields

0: Function

ModuleItem(Module)

Tuple Fields

0: Module

TypedefItem(Typedef, bool)

Tuple Fields

0: Typedef
1: bool

OpaqueTyItem(OpaqueTy)

Tuple Fields

0: OpaqueTy

StaticItem(Static)

Tuple Fields

0: Static

ConstantItem(Constant)

Tuple Fields

0: Constant

TraitItem(Trait)

Tuple Fields

0: Trait

TraitAliasItem(TraitAlias)

Tuple Fields

0: TraitAlias

ImplItem(Impl)

Tuple Fields

0: Impl

TyMethodItem(Function)

Tuple Fields

0: Function

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

MethodItem(Function, Option<Defaultness>)

Tuple Fields

0: Function
1: Option<Defaultness>

A method with a body.

StructFieldItem(Type)

Tuple Fields

0: Type

VariantItem(Variant)

Tuple Fields

0: Variant

ForeignFunctionItem(Function)

Tuple Fields

0: Function

fns from an extern block

ForeignStaticItem(Static)

Tuple Fields

0: Static

statics from an extern block

ForeignTypeItem

types from an extern block

MacroItem(Macro)

Tuple Fields

0: Macro

ProcMacroItem(ProcMacro)

Tuple Fields

0: ProcMacro

PrimitiveItem(PrimitiveType)

Tuple Fields

0: PrimitiveType

AssocConstItem(Type, Option<ConstantKind>)

Tuple Fields

0: Type
1: Option<ConstantKind>

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

Tuple Fields

0: Vec<GenericBound>
1: 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>)

Tuple Fields

0: Box<ItemKind>

An item that has been stripped by a rustdoc pass

KeywordItem(Symbol)

Tuple Fields

0: Symbol

Implementations

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

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

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

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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

Size for each variant:

  • ExternCrateItem: 7 bytes
  • ImportItem: 71 bytes
  • StructItem: 87 bytes
  • UnionItem: 87 bytes
  • EnumItem: 87 bytes
  • FunctionItem: 167 bytes
  • ModuleItem: 39 bytes
  • TypedefItem: 199 bytes
  • OpaqueTyItem: 79 bytes
  • StaticItem: 95 bytes
  • ConstantItem: 111 bytes
  • TraitItem: 111 bytes
  • TraitAliasItem: 79 bytes
  • ImplItem: 223 bytes
  • TyMethodItem: 167 bytes
  • MethodItem: 167 bytes
  • StructFieldItem: 79 bytes
  • VariantItem: 47 bytes
  • ForeignFunctionItem: 167 bytes
  • ForeignStaticItem: 95 bytes
  • ForeignTypeItem: 0 bytes
  • MacroItem: 31 bytes
  • ProcMacroItem: 39 bytes
  • PrimitiveItem: 1 byte
  • AssocConstItem: 111 bytes
  • AssocTypeItem: 103 bytes
  • StrippedItem: 15 bytes
  • KeywordItem: 7 bytes