[−][src]Struct rustdoc::clean::Item
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
[src]
impl Item
pub fn doc_value<'a>(&'a self) -> Option<&'a str>
[src]
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>
[src]
pub fn collapsed_doc_value(&self) -> Option<String>
Finds all doc
attributes as NameValues and returns their corresponding values, joined
with newlines.
pub fn links(&self) -> Vec<(String, String)>
[src]
pub fn links(&self) -> Vec<(String, String)>
pub fn is_crate(&self) -> bool
[src]
pub fn is_crate(&self) -> bool
pub fn is_mod(&self) -> bool
[src]
pub fn is_mod(&self) -> bool
pub fn is_trait(&self) -> bool
[src]
pub fn is_trait(&self) -> bool
pub fn is_struct(&self) -> bool
[src]
pub fn is_struct(&self) -> bool
pub fn is_enum(&self) -> bool
[src]
pub fn is_enum(&self) -> bool
pub fn is_associated_type(&self) -> bool
[src]
pub fn is_associated_type(&self) -> bool
pub fn is_associated_const(&self) -> bool
[src]
pub fn is_associated_const(&self) -> bool
pub fn is_method(&self) -> bool
[src]
pub fn is_method(&self) -> bool
pub fn is_ty_method(&self) -> bool
[src]
pub fn is_ty_method(&self) -> bool
pub fn is_typedef(&self) -> bool
[src]
pub fn is_typedef(&self) -> bool
pub fn is_primitive(&self) -> bool
[src]
pub fn is_primitive(&self) -> bool
pub fn is_union(&self) -> bool
[src]
pub fn is_union(&self) -> bool
pub fn is_import(&self) -> bool
[src]
pub fn is_import(&self) -> bool
pub fn is_extern_crate(&self) -> bool
[src]
pub fn is_extern_crate(&self) -> bool
pub fn is_keyword(&self) -> bool
[src]
pub fn is_keyword(&self) -> bool
pub fn is_stripped(&self) -> bool
[src]
pub fn is_stripped(&self) -> bool
pub fn has_stripped_fields(&self) -> Option<bool>
[src]
pub fn has_stripped_fields(&self) -> Option<bool>
pub fn stability_class(&self) -> Option<String>
[src]
pub fn stability_class(&self) -> Option<String>
pub fn stable_since(&self) -> Option<&str>
[src]
pub fn stable_since(&self) -> Option<&str>
pub fn is_non_exhaustive(&self) -> bool
[src]
pub fn is_non_exhaustive(&self) -> bool
pub fn type_(&self) -> ItemType
[src]
pub fn type_(&self) -> ItemType
Returns a documentation-level item type from the item.
Trait Implementations
impl Clone for Item
[src]
impl Clone for Item
fn clone(&self) -> Item
[src]
fn clone(&self) -> Item
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Encodable for Item
[src]
impl Encodable for Item
fn encode<__S: Encoder>(&self, s: &mut __S) -> Result<(), __S::Error>
[src]
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
[src]
impl Decodable for Item
fn decode<__D: Decoder>(d: &mut __D) -> Result<Item, __D::Error>
[src]
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
[src]
impl Debug for Item
fn fmt(&self, fmt: &mut Formatter) -> Result
[src]
fn fmt(&self, fmt: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Clean<Item> for Module
[src]
impl Clean<Item> for Module
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl Clean<Item> for Function
[src]
impl Clean<Item> for Function
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl Clean<Item> for Trait
[src]
impl Clean<Item> for Trait
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl Clean<Item> for TraitItem
[src]
impl Clean<Item> for TraitItem
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl Clean<Item> for ImplItem
[src]
impl Clean<Item> for ImplItem
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl<'tcx> Clean<Item> for AssociatedItem
[src]
impl<'tcx> Clean<Item> for AssociatedItem
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl Clean<Item> for StructField
[src]
impl Clean<Item> for StructField
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl<'tcx> Clean<Item> for FieldDef
[src]
impl<'tcx> Clean<Item> for FieldDef
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl Clean<Item> for Variant
[src]
impl Clean<Item> for Variant
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl<'tcx> Clean<Item> for VariantDef
[src]
impl<'tcx> Clean<Item> for VariantDef
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl Clean<Item> for Typedef
[src]
impl Clean<Item> for Typedef
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl Clean<Item> for Existential
[src]
impl Clean<Item> for Existential
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl Clean<Item> for Static
[src]
impl Clean<Item> for Static
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl Clean<Item> for Constant
[src]
impl Clean<Item> for Constant
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl Clean<Item> for ExternCrate
[src]
impl Clean<Item> for ExternCrate
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl Clean<Item> for ForeignItem
[src]
impl Clean<Item> for ForeignItem
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl Clean<Item> for Macro
[src]
impl Clean<Item> for Macro
fn clean(&self, cx: &DocContext) -> Item
[src]
fn clean(&self, cx: &DocContext) -> Item
impl<'a> From<&'a Item> for ItemType
[src]
impl<'a> From<&'a Item> for ItemType
Auto Trait Implementations
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
type Owned = T
fn to_owned(&self) -> T
[src]
fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
fn clone_into(&self, target: &mut T)
[src]
fn clone_into(&self, target: &mut T)
🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
try_from
)Performs the conversion.
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
ⓘImportant traits for &'a mut Rfn borrow(&self) -> &T
[src]
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
try_from
)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
try_from
)Performs the conversion.
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
ⓘImportant traits for &'a mut Rfn borrow_mut(&mut self) -> &mut T
[src]
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId
[src]
fn get_type_id(&self) -> TypeId
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static
Gets the TypeId
of self
. Read more
impl<T> Encodable for T where
T: UseSpecializedEncodable + ?Sized,
[src]
impl<T> Encodable for T where
T: UseSpecializedEncodable + ?Sized,
fn encode<E>(&self, e: &mut E) -> Result<(), <E as Encoder>::Error> where
E: Encoder,
[src]
fn encode<E>(&self, e: &mut E) -> Result<(), <E as Encoder>::Error> where
E: Encoder,
🔬 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<T> Decodable for T where
T: UseSpecializedDecodable,
[src]
impl<T> Decodable for T where
T: UseSpecializedDecodable,
fn decode<D>(d: &mut D) -> Result<T, <D as Decoder>::Error> where
D: Decoder,
[src]
fn decode<D>(d: &mut D) -> Result<T, <D as Decoder>::Error> where
D: Decoder,
🔬 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<E> SpecializationError for E
[src]
impl<E> SpecializationError for E
fn not_found<S, T>(trait_name: &'static str, method_name: &'static str) -> E where
T: ?Sized,
[src]
fn not_found<S, T>(trait_name: &'static str, method_name: &'static str) -> E where
T: ?Sized,
🔬 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?
Create an error for a missing method specialization. Defaults to panicking with type, trait & method names. S
is the encoder/decoder state type, T
is the type being encoded/decoded, and the arguments are the names of the trait and method that should've been overridden. Read more
impl<T> Erased for T
[src]
impl<T> Erased for T
impl<T> Send for T where
T: ?Sized,
[src]
impl<T> Send for T where
T: ?Sized,
impl<T> Sync for T where
T: ?Sized,
[src]
impl<T> Sync for T where
T: ?Sized,
impl<T> Erased for T
impl<T> Erased for T
impl<T> MaybeResult for T
[src]
impl<T> MaybeResult for T
fn from_ok(x: T) -> T
[src]
fn from_ok(x: T) -> T
🔬 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?
fn map_same<F>(self, f: F) -> T where
F: FnOnce(T) -> T,
[src]
fn map_same<F>(self, f: F) -> T where
F: FnOnce(T) -> T,
🔬 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<'a, T> Captures for T where
T: ?Sized,
[src]
impl<'a, T> Captures for T where
T: ?Sized,