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(Function),
    ModuleItem(Module),
    TypedefItem(Typedef),
    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),
    TyAssocConstItem(Type),
    AssocConstItem(Type, ConstantKind),
    TyAssocTypeItem(Box<Generics>, Vec<GenericBound>),
    AssocTypeItem(Typedef, Vec<GenericBound>),
    StrippedItem(Box<ItemKind>),
    KeywordItem(Symbol),
}

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(Function)`

`ModuleItem(Module)`

`TypedefItem(Typedef)`

`OpaqueTyItem(OpaqueTy)`

`StaticItem(Static)`

`ConstantItem(Constant)`

`TraitItem(Trait)`

`TraitAliasItem(TraitAlias)`

`ImplItem(Impl)`

`TyMethodItem(Function)`

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

`MethodItem(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(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(Type)`

A required associated constant in a trait declaration.

`AssocConstItem(Type, ConstantKind)`

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

`TyAssocTypeItem(Box<Generics>, Vec<GenericBound>)`

A required associated type in a trait declaration.

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

`AssocTypeItem(Typedef, 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(Symbol)`

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.

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

impl !RefUnwindSafe for ItemKind

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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)

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

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

source

impl<'a, T> Captures<'a> for T where
T: ?Sized,

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: 240 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: 215 bytes
OpaqueTyItem: 79 bytes
StaticItem: 103 bytes
ConstantItem: 119 bytes
TraitItem: 111 bytes
TraitAliasItem: 79 bytes
ImplItem: 231 bytes
TyMethodItem: 167 bytes
MethodItem: 167 bytes
StructFieldItem: 87 bytes
VariantItem: 47 bytes
ForeignFunctionItem: 167 bytes
ForeignStaticItem: 103 bytes
ForeignTypeItem: 0 bytes
MacroItem: 31 bytes
ProcMacroItem: 39 bytes
PrimitiveItem: 1 byte
TyAssocConstItem: 87 bytes
AssocConstItem: 119 bytes
TyAssocTypeItem: 39 bytes
AssocTypeItem: 239 bytes
StrippedItem: 15 bytes
KeywordItem: 7 bytes

Enum rustdoc::clean::types::ItemKind

Variants

ExternCrateItem

Fields

ImportItem(Import)

StructItem(Struct)

UnionItem(Union)

EnumItem(Enum)

FunctionItem(Function)

ModuleItem(Module)

TypedefItem(Typedef)

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)

TyAssocConstItem(Type)

AssocConstItem(Type, ConstantKind)

TyAssocTypeItem(Box<Generics>, Vec<GenericBound>)

AssocTypeItem(Typedef, Vec<GenericBound>)

StrippedItem(Box<ItemKind>)

KeywordItem(Symbol)

Implementations

impl ItemKind

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

Trait Implementations

impl Clone for ItemKind

fn clone(&self) -> ItemKind

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

impl Debug for ItemKind

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

Auto Trait Implementations

impl !RefUnwindSafe for ItemKind

impl !Send for ItemKind

impl !Sync for ItemKind

impl Unpin for ItemKind

impl !UnwindSafe for ItemKind

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

`ExternCrateItem`

`ImportItem(Import)`

`StructItem(Struct)`

`UnionItem(Union)`

`EnumItem(Enum)`

`FunctionItem(Function)`

`ModuleItem(Module)`

`TypedefItem(Typedef)`

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

`TyAssocConstItem(Type)`

`AssocConstItem(Type, ConstantKind)`

`TyAssocTypeItem(Box<Generics>, Vec<GenericBound>)`

`AssocTypeItem(Typedef, Vec<GenericBound>)`

`StrippedItem(Box<ItemKind>)`

`KeywordItem(Symbol)`

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

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

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

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

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

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

impl<'a, T> Captures<'a> for T where
T: ?Sized,