Struct rustdoc::clean::Item
[−]
[src]
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>, }
🔬 This is a nightly-only experimental API. (
rustdoc
)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
🔬 This is a nightly-only experimental API. (
rustdoc
)Stringified span
name: Option<String>
🔬 This is a nightly-only experimental API. (
rustdoc
)Not everything has a name. E.g., impls
attrs: Attributes
🔬 This is a nightly-only experimental API. (
rustdoc
)inner: ItemEnum
🔬 This is a nightly-only experimental API. (
rustdoc
)visibility: Option<Visibility>
🔬 This is a nightly-only experimental API. (
rustdoc
)def_id: DefId
🔬 This is a nightly-only experimental API. (
rustdoc
)stability: Option<Stability>
🔬 This is a nightly-only experimental API. (
rustdoc
)deprecation: Option<Deprecation>
🔬 This is a nightly-only experimental API. (
rustdoc
)Methods
impl Item
[src]
fn doc_value<'a>(&'a self) -> Option<&'a str>
🔬 This is a nightly-only experimental API. (
rustdoc
)Finds the doc
attribute as a NameValue and returns the corresponding
value found.
fn is_crate(&self) -> bool
🔬 This is a nightly-only experimental API. (
rustdoc
)fn is_mod(&self) -> bool
🔬 This is a nightly-only experimental API. (
rustdoc
)fn is_trait(&self) -> bool
🔬 This is a nightly-only experimental API. (
rustdoc
)fn is_struct(&self) -> bool
🔬 This is a nightly-only experimental API. (
rustdoc
)fn is_enum(&self) -> bool
🔬 This is a nightly-only experimental API. (
rustdoc
)fn is_fn(&self) -> bool
🔬 This is a nightly-only experimental API. (
rustdoc
)fn is_associated_type(&self) -> bool
🔬 This is a nightly-only experimental API. (
rustdoc
)fn is_associated_const(&self) -> bool
🔬 This is a nightly-only experimental API. (
rustdoc
)fn is_method(&self) -> bool
🔬 This is a nightly-only experimental API. (
rustdoc
)fn is_ty_method(&self) -> bool
🔬 This is a nightly-only experimental API. (
rustdoc
)fn is_primitive(&self) -> bool
🔬 This is a nightly-only experimental API. (
rustdoc
)fn is_stripped(&self) -> bool
🔬 This is a nightly-only experimental API. (
rustdoc
)fn has_stripped_fields(&self) -> Option<bool>
🔬 This is a nightly-only experimental API. (
rustdoc
)fn stability_class(&self) -> Option<String>
🔬 This is a nightly-only experimental API. (
rustdoc
)fn stable_since(&self) -> Option<&str>
🔬 This is a nightly-only experimental API. (
rustdoc
)fn type_(&self) -> ItemType
🔬 This is a nightly-only experimental API. (
rustdoc
)Returns a documentation-level item type from the item.
Trait Implementations
impl Clone for Item
[src]
fn clone(&self) -> Item
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl Encodable for Item
[src]
fn encode<__S: Encoder>(&self, __arg_0: &mut __S) -> Result<(), __S::Error>
🔬 This is a nightly-only experimental API. (rustc_private
)
deprecated in favor of rustc-serialize on crates.io
impl Decodable for Item
[src]
fn decode<__D: Decoder>(__arg_0: &mut __D) -> Result<Item, __D::Error>
🔬 This is a nightly-only experimental API. (rustc_private
)
deprecated in favor of rustc-serialize on crates.io