Struct rustdoc::clean::types::Item

pub(crate) struct Item {
    pub(crate) name: Option<Symbol>,
    pub(crate) attrs: Box<Attributes>,
    pub(crate) visibility: Visibility,
    pub(crate) kind: Box<ItemKind>,
    pub(crate) def_id: FakeDefId,
    pub(crate) cfg: Option<Arc<Cfg>>,
}

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

name: Option<Symbol>

The name of this item. Optional because not every item has a name, e.g. impls.

attrs: Box<Attributes>

visibility: Visibility

kind: Box<ItemKind>

Information about this item that is specific to what kind of item it is. E.g., struct vs enum vs function.

def_id: FakeDefId

cfg: Option<Arc<Cfg>>

Implementations

impl Item

pub(crate) fn stability<'tcx>(
    &self,
    tcx: TyCtxt<'tcx>
) -> Option<&'tcx Stability>

pub(crate) fn const_stability<'tcx>(
    &self,
    tcx: TyCtxt<'tcx>
) -> Option<&'tcx ConstStability>

pub(crate) fn deprecation(&self, tcx: TyCtxt<'_>) -> Option<Deprecation>

pub(crate) fn inner_docs(&self, tcx: TyCtxt<'_>) -> bool

pub(crate) fn span(&self, tcx: TyCtxt<'_>) -> Span

pub(crate) fn attr_span(&self, tcx: TyCtxt<'_>) -> Span

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

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: &mut 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: &mut DocContext<'_>
) -> Item

pub fn from_def_id_and_attrs_and_parts(
    def_id: DefId,
    name: Option<Symbol>,
    kind: ItemKind,
    attrs: Box<Attributes>,
    cx: &mut DocContext<'_>,
    cfg: Option<Arc<Cfg>>
) -> 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, cx: &Context<'_>) -> 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, tcx: TyCtxt<'_>) -> Option<String>

pub(crate) fn stable_since(&self, tcx: TyCtxt<'_>) -> Option<SymbolStr>

pub(crate) fn const_stable_since(&self, tcx: TyCtxt<'_>) -> 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

Trait Implementations

impl Clean<Item> for Module<'_>

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

impl Clean<Item> for TraitItem<'_>

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

impl Clean<Item> for ImplItem<'_>

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

impl Clean<Item> for AssocItem

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

impl Clean<Item> for FieldDef<'_>

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

impl Clean<Item> for FieldDef

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

impl Clean<Item> for VariantDef

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

impl Clean<Item> for Variant<'_>

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

impl Clean<Item> for (&ForeignItem<'_>, Option<Symbol>)

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

impl Clean<Item> for (&MacroDef<'_>, Option<Symbol>)

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

impl Clone for Item

fn clone(&self) -> Item

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Formats the value using the given formatter.

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

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

Performs the conversion.