Struct rustdoc::clean::types::Attributes

pub(crate) struct Attributes {
    pub(crate) doc_strings: Vec<DocFragment>,
    pub(crate) other_attrs: Vec<Attribute>,
}

The attributes on an Item, including attributes like #[derive(...)] and #[inline], as well as doc comments.

Fields

doc_strings: Vec<DocFragment>

other_attrs: Vec<Attribute>

Implementations

impl Attributes

pub(crate) fn lists(&self, name: Symbol) -> ListAttributesIter<'_>

pub(crate) fn extract_include(mi: &MetaItem) -> Option<(Symbol, Symbol)>

Reads a MetaItem from within an attribute, looks for whether it is a #[doc(include="file")], and returns the filename and contents of the file as loaded from its expansion.

pub(crate) fn has_doc_flag(&self, flag: Symbol) -> bool

pub(crate) fn from_ast(
    attrs: &[Attribute],
    additional_attrs: Option<(&[Attribute], DefId)>
) -> Attributes

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

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

pub(crate) fn collapsed_doc_value_by_module_level(
    &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.

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<[String]>

impl Attributes

pub(crate) fn unindent_doc_comments(&mut self)

Trait Implementations

impl Clean<Attributes> for [Attribute]

fn clean(&self, _cx: &mut DocContext<'_>) -> Attributes

impl Clone for Attributes

fn clone(&self) -> Attributes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attributes

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

Formats the value using the given formatter.

impl Default for Attributes

fn default() -> Attributes

Returns the “default value” for a type.

impl Hash for Attributes

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Attributes> for Attributes

fn eq(&self, rhs: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for Attributes