Enum rustdoc::clean::types::ItemKind

source ·
pub(crate) enum ItemKind {
Show 30 variants ExternCrateItem { src: Option<Symbol>, }, ImportItem(Import), StructItem(Struct), UnionItem(Union), EnumItem(Enum), FunctionItem(Box<Function>), ModuleItem(Module), TypeAliasItem(Box<TypeAlias>), OpaqueTyItem(OpaqueTy), 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>), ForeignStaticItem(Static), ForeignTypeItem, MacroItem(Macro), ProcMacroItem(ProcMacro), PrimitiveItem(PrimitiveType), TyAssocConstItem(Generics, Box<Type>), ConstantItem(Generics, Box<Type>, Constant), AssocConstItem(Generics, Box<Type>, ConstantKind), 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>)

§

OpaqueTyItem(OpaqueTy)

§

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>)

fns from an extern block

§

ForeignStaticItem(Static)

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(Generics, Box<Type>, Constant)

§

AssocConstItem(Generics, Box<Type>, ConstantKind)

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§

source§

impl ItemKind

source

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.

source

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

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

Trait Implementations§

source§

impl Clone for ItemKind

source§

fn clone(&self) -> ItemKind

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ItemKind

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

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

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

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

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Size for each variant:

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