Enum rustdoc::clean::types::ItemKind

source · [−]

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

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

`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

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

source

pub fn from(t: T) -> T

Performs the conversion.

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

source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

pub 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

pub fn to_owned(&self) -> T

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

source

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

source

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

source

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

Performs the conversion.

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

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

Enum rustdoc::clean::types::ItemKind

Variants

ExternCrateItem

Fields

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)

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,

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

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

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

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

pub unsafe fn drop(ptr: usize)

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

pub 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

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

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

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

`ExternCrateItem`

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

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,