Struct rustdoc::clean::types::Attributes

pub(crate) struct Attributes {
    pub(crate) doc_strings: Vec<DocFragment>,
    pub(crate) other_attrs: Vec<Attribute>,
    pub(crate) cfg: Option<Arc<Cfg>>,
    pub(crate) span: Option<Span>,
    pub(crate) links: Vec<ItemLink>,
    pub(crate) inner_docs: bool,
}

Fields

doc_strings: Vec<DocFragment>

other_attrs: Vec<Attribute>

cfg: Option<Arc<Cfg>>

span: Option<Span>

links: Vec<ItemLink>

map from Rust paths to resolved defs and potential URL fragments

inner_docs: bool

Implementations

impl Attributes

pub(crate) fn extract_cfg(mi: &MetaItem) -> Option<&MetaItem>

Extracts the content from an attribute #[doc(cfg(content))].

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

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(
    diagnostic: &Handler,
    attrs: &[Attribute],
    additional_attrs: Option<(&[Attribute], DefId)>
) -> Attributes

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

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

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 links(&self, krate: &CrateNum) -> Vec<RenderedLink>

Gets links as a vector

Cache must be populated before call

pub(crate) fn get_doc_aliases(&self) -> FxHashSet<String>

impl Attributes

pub(crate) fn collapse_doc_comments(&mut self)

impl Attributes

pub(crate) fn unindent_doc_comments(&mut self)

Trait Implementations

impl AttributesExt for Attributes

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

Finds an attribute as List and returns the list of attributes nested inside.

impl Clean<Attributes> for [Attribute]

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> Attributes

impl Clone for Attributes

pub fn clone(&self) -> Attributes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attributes

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

Formats the value using the given formatter.

impl Default for Attributes

pub fn default() -> Attributes

Returns the "default value" for a type.

impl Eq for Attributes

impl Hash for Attributes

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

Feeds this value into the given Hasher.

pub 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

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.