Enum rustdoc_types::ItemEnum

pub enum ItemEnum {
    Module(Module),
    ExternCrate {
        name: String,
        rename: Option<String>,
    },
    Import(Import),
    Union(Union),
    Struct(Struct),
    StructField(Type),
    Enum(Enum),
    Variant(Variant),
    Function(Function),
    Trait(Trait),
    TraitAlias(TraitAlias),
    Impl(Impl),
    TypeAlias(TypeAlias),
    Constant {
        type_: Type,
        const_: Constant,
    },
    Static(Static),
    ForeignType,
    Macro(String),
    ProcMacro(ProcMacro),
    Primitive(Primitive),
    AssocConst {
        type_: Type,
        default: Option<String>,
    },
    AssocType {
        generics: Generics,
        bounds: Vec<GenericBound>,
        default: Option<Type>,
    },
}

Specific fields of an item.

Part of Item.

Variants

Module(Module)

A module declaration, e.g. mod foo; or mod foo {}

ExternCrate

A crate imported via the extern crate syntax.

Fields

name: String

The name of the imported crate.

rename: Option<String>

If the crate is renamed, this is its name in the crate.

Import(Import)

An import of 1 or more items into scope, using the use keyword.

Union(Union)

A union declaration.

Struct(Struct)

A struct declaration.

StructField(Type)

A field of a struct.

Enum(Enum)

An enum declaration.

Variant(Variant)

A variant of a enum.

Function(Function)

A function declaration (including methods and other associated functions)

Trait(Trait)

A trait declaration.

TraitAlias(TraitAlias)

A trait alias declaration, e.g. trait Int = Add + Sub + Mul + Div;

See the tracking issue

Impl(Impl)

An impl block.

TypeAlias(TypeAlias)

A type alias declaration, e.g. type Pig = std::borrow::Cow<'static, str>;

Constant

The declaration of a constant, e.g. const GREETING: &str = "Hi :3";

Fields

type_: Type

The type of the constant.

const_: Constant

The declared constant itself.

Static(Static)

A declaration of a static.

ForeignType

types from an extern block.

See the tracking issue

Macro(String)

A macro_rules! declarative macro. Contains a single string with the source representation of the macro with the patterns stripped.

ProcMacro(ProcMacro)

A procedural macro.

Primitive(Primitive)

A primitive type, e.g. u32.

Items of this kind only come from the core library.

AssocConst

An associated constant of a trait or a type.

Fields

type_: Type

The type of the constant.

default: Option<String>

The stringified expression for the default value, if provided, e.g.

const X: usize = 640 * 1024;
//               ^^^^^^^^^^

AssocType

An associated type of a trait or a type.

Fields

generics: Generics

The generic parameters and where clauses on ahis associated type.

bounds: Vec<GenericBound>

The bounds for this associated type. e.g.

trait IntoIterator {
    type Item;
    type IntoIter: Iterator<Item = Self::Item>;
//                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
}

default: Option<Type>

The default for this type, if provided, e.g.

type X = usize;
//       ^^^^^

Trait Implementations

impl Clone for ItemEnum

fn clone(&self) -> ItemEnum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ItemEnum

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ItemEnum

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ItemEnum

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ItemEnum

fn eq(&self, other: &ItemEnum) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ItemEnum

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ItemEnum

impl StructuralPartialEq for ItemEnum