Struct rustdoc::clean::types::Attributes
source · pub(crate) struct Attributes {
pub(crate) doc_strings: Vec<DocFragment>,
pub(crate) other_attrs: AttrVec,
}
Expand description
The attributes on an Item
, including attributes like #[derive(...)]
and #[inline]
,
as well as doc comments.
Fields§
§doc_strings: Vec<DocFragment>
§other_attrs: AttrVec
Implementations§
source§impl Attributes
impl Attributes
pub(crate) fn lists(
&self,
name: Symbol
) -> impl Iterator<Item = NestedMetaItem> + '_
pub(crate) fn has_doc_flag(&self, flag: Symbol) -> bool
pub(crate) fn from_ast(attrs: &[Attribute]) -> Attributes
pub(crate) fn from_ast_with_additional(
attrs: &[Attribute],
(additional_attrs, def_id): (&[Attribute], DefId)
) -> Attributes
pub(crate) fn from_ast_iter<'a>(
attrs: impl Iterator<Item = (&'a Attribute, Option<DefId>)>,
doc_only: bool
) -> Attributes
sourcepub(crate) fn doc_value(&self) -> Option<String>
pub(crate) fn doc_value(&self) -> Option<String>
Finds the doc
attribute as a NameValue and returns the corresponding
value found.
sourcepub(crate) fn prepare_to_doc_link_resolution(
&self
) -> FxHashMap<Option<DefId>, String>
pub(crate) fn prepare_to_doc_link_resolution(
&self
) -> FxHashMap<Option<DefId>, String>
Return the doc-comments on this item, grouped by the module they came from. The module can be different if this is a re-export with added documentation.
The last newline is not trimmed so the produced strings are reusable between early and late doc link resolution regardless of their position.
sourcepub(crate) fn collapsed_doc_value(&self) -> Option<String>
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 get_doc_aliases(&self) -> Box<[Symbol]>
Trait Implementations§
source§impl Clone for Attributes
impl Clone for Attributes
source§fn clone(&self) -> Attributes
fn clone(&self) -> Attributes
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for Attributes
impl Debug for Attributes
source§impl Default for Attributes
impl Default for Attributes
source§fn default() -> Attributes
fn default() -> Attributes
source§impl PartialEq<Attributes> for Attributes
impl PartialEq<Attributes> for Attributes
impl Eq for Attributes
Auto Trait Implementations§
impl !RefUnwindSafe for Attributes
impl !Send for Attributes
impl !Sync for Attributes
impl Unpin for Attributes
impl !UnwindSafe for Attributes
Blanket Implementations§
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...)
attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.
Size: 32 bytes