Struct rustdoc::clean::types::Item

pub(crate) struct Item {
    pub(crate) source: Span,
    pub(crate) name: Option<String>,
    pub(crate) attrs: Attributes,
    pub(crate) visibility: Visibility,
    pub(crate) kind: ItemKind,
    pub(crate) def_id: DefId,
    pub(crate) stability: Option<Stability>,
    pub(crate) deprecation: Option<Deprecation>,
}

Anything with a source location and set of attributes and, optionally, a name. That is, anything that can be documented. This doesn't correspond directly to the AST's concept of an item; it's a strict superset.

Fields

source: Span

Stringified span

name: Option<String>

Not everything has a name. E.g., impls

attrs: Attributes

visibility: Visibility

kind: ItemKind

def_id: DefId

stability: Option<Stability>

deprecation: Option<Deprecation>

Implementations

impl Item

pub(crate) fn doc_value(&self) -> Option<&str>

Finds the doc attribute as a NameValue and returns the corresponding value found.

pub fn from_hir_id_and_parts(
    hir_id: HirId,
    name: Option<Symbol>,
    kind: ItemKind,
    cx: &DocContext<'_>
) -> Item

Convenience wrapper around Self::from_def_id_and_parts which converts hir_id to a DefId

pub fn from_def_id_and_parts(
    def_id: DefId,
    name: Option<Symbol>,
    kind: ItemKind,
    cx: &DocContext<'_>
) -> Item

pub(crate) fn collapsed_doc_value(&self) -> Option<String>

Finds all doc attributes as NameValues and returns their corresponding values, joined with newlines.

pub(crate) fn links(&self) -> Vec<RenderedLink>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub(crate) fn has_stripped_fields(&self) -> Option<bool>

pub(crate) fn stability_class(&self) -> Option<String>

pub(crate) fn stable_since(&self) -> Option<SymbolStr>

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

pub(crate) fn type_(&self) -> ItemType

Returns a documentation-level item type from the item.

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

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

See comments on next_def_id

Trait Implementations

impl<'_> Clean<Item> for Module<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for Function<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for Union<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for Enum<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for Variant<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl Clean<Item> for VariantDef

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for Typedef<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for OpaqueTy<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for Static<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for Constant<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for ForeignItem<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl Clean<Item> for Macro

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for Trait<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl Clean<Item> for ProcMacro

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for TraitAlias<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for TraitItem<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for ImplItem<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl Clean<Item> for AssocItem

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for StructField<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl Clean<Item> for FieldDef

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl<'_> Clean<Item> for Struct<'_>

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Item

impl Clone for Item

pub fn clone(&self) -> Item

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Formats the value using the given formatter.

impl<'a> From<&'a Item> for ItemType

pub fn from(item: &'a Item) -> ItemType

Performs the conversion.