Struct rustdoc::clean::Item

pub struct Item {
    pub source: Span,
    pub name: Option<String>,
    pub attrs: Attributes,
    pub inner: ItemEnum,
    pub visibility: Option<Visibility>,
    pub def_id: DefId,
    pub stability: Option<Stability>,
    pub 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

inner: ItemEnum

visibility: Option<Visibility>

def_id: DefId

stability: Option<Stability>

deprecation: Option<Deprecation>

Methods

impl Item

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

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

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

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

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn links(&self) -> Vec<(String, String)>

pub fn is_crate(&self) -> bool

pub fn is_mod(&self) -> bool

pub fn is_trait(&self) -> bool

pub fn is_struct(&self) -> bool

pub fn is_enum(&self) -> bool

pub fn is_fn(&self) -> bool

pub fn is_associated_type(&self) -> bool

pub fn is_associated_const(&self) -> bool

pub fn is_method(&self) -> bool

pub fn is_ty_method(&self) -> bool

pub fn is_typedef(&self) -> bool

pub fn is_primitive(&self) -> bool

pub fn is_union(&self) -> bool

pub fn is_import(&self) -> bool

pub fn is_extern_crate(&self) -> bool

pub fn is_keyword(&self) -> bool

pub fn is_stripped(&self) -> bool

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

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

pub fn stable_since(&self) -> Option<&str>

pub fn type_(&self) -> ItemType

Returns a documentation-level item type from the item.

Trait Implementations

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 Encodable for Item

fn encode<__S: Encoder>(&self, s: &mut __S) -> Result<(), __S::Error>

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

impl Decodable for Item

fn decode<__D: Decoder>(d: &mut __D) -> Result<Item, __D::Error>

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

impl Debug for Item

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clean<Item> for Module

fn clean(&self, cx: &DocContext) -> Item

impl Clean<Item> for Function

fn clean(&self, cx: &DocContext) -> Item

impl Clean<Item> for Trait

fn clean(&self, cx: &DocContext) -> Item

impl Clean<Item> for TraitItem

fn clean(&self, cx: &DocContext) -> Item

impl Clean<Item> for ImplItem

fn clean(&self, cx: &DocContext) -> Item

impl<'tcx> Clean<Item> for AssociatedItem

fn clean(&self, cx: &DocContext) -> Item

impl Clean<Item> for StructField

fn clean(&self, cx: &DocContext) -> Item

impl<'tcx> Clean<Item> for FieldDef

fn clean(&self, cx: &DocContext) -> Item

impl Clean<Item> for Variant

fn clean(&self, cx: &DocContext) -> Item

impl<'tcx> Clean<Item> for VariantDef

fn clean(&self, cx: &DocContext) -> Item

impl Clean<Item> for Typedef

fn clean(&self, cx: &DocContext) -> Item

impl Clean<Item> for Static

fn clean(&self, cx: &DocContext) -> Item

impl Clean<Item> for Constant

fn clean(&self, cx: &DocContext) -> Item

impl Clean<Item> for ExternCrate

fn clean(&self, cx: &DocContext) -> Item

impl Clean<Item> for ForeignItem

fn clean(&self, cx: &DocContext) -> Item

impl Clean<Item> for Macro

fn clean(&self, cx: &DocContext) -> Item

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

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

Performs the conversion.