Struct rustdoc::clean::Attributes

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

Fields

doc_strings: Vec<DocFragment>

other_attrs: Vec<Attribute>

cfg: Option<Arc<Cfg>>

span: Option<Span>

links: Vec<(String, Option<DefId>, Option<String>)>

map from Rust paths to resolved defs and potential URL fragments

inner_docs: bool

Methods

impl Attributes

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

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

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 fn has_doc_flag(&self, flag: &str) -> bool

pub fn from_ast(diagnostic: &Handler, attrs: &[Attribute]) -> Attributes

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>

Finds all doc attributes as NameValues and returns their corresponding values, joined with newlines.

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn links(&self, krate: &CrateNum) -> Vec<(String, String)>

Get links as a vector

Cache must be populated before call

impl Attributes

pub fn collapse_doc_comments(&mut self)

impl Attributes

pub fn unindent_doc_comments(&mut self)

Trait Implementations

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 Encodable for Attributes

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 Attributes

fn decode<__D: Decoder>(d: &mut __D) -> Result<Attributes, __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 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 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

fn assert_receiver_is_total_eq(&self)

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 AttributesExt for Attributes

Important traits for ListAttributesIter<'a>

impl<'a> Iterator for ListAttributesIter<'a> type Item = NestedMetaItem;

fn lists<'a>(&'a self, name: &'a str) -> ListAttributesIter<'a>

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

impl Clean<Attributes> for [Attribute]

fn clean(&self, cx: &DocContext) -> Attributes