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
) -> impl Iterator<Item = NestedMetaItem> + '_

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 from_ast_iter<'a>(
    attrs: impl Iterator<Item = (&'a Attribute, Option<DefId>)>,
    doc_only: bool
) -> 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 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.

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

impl<'tcx> Clean<'tcx, 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 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 ==.

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

This method tests for !=.

impl Eq for Attributes

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: 48 bytes