Struct rustdoc::clean::types::Attributes[][src]

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.


doc_strings: Vec<DocFragment>other_attrs: Vec<Attribute>


impl Attributes[src]

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

Notable traits for ListAttributesIter<'a>

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

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

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

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

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

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

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

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

pub(crate) fn collapsed_doc_value_by_module_level(
) -> 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>[src]

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

pub(crate) fn get_doc_aliases(&self) -> Box<[String]>[src]

impl Attributes[src]

pub(crate) fn unindent_doc_comments(&mut self)[src]

Trait Implementations

impl Clean<Attributes> for [Attribute][src]

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

impl Clone for Attributes[src]

fn clone(&self) -> Attributes[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for Attributes[src]

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

Formats the value using the given formatter. Read more

impl Default for Attributes[src]

fn default() -> Attributes[src]

Returns the “default value” for a type. Read more

impl Hash for Attributes[src]

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

Feeds this value into the given Hasher. Read more

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

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq<Attributes> for Attributes[src]

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

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

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

This method tests for !=.

impl Eq for Attributes[src]

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

impl<T> Any for T where
    T: 'static + ?Sized

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
    U: From<T>, 

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V

impl<T> WithConstness for T[src]

fn with_constness(self, constness: Constness) -> ConstnessAnd<Self>[src]

fn with_const(self) -> ConstnessAnd<Self>[src]

fn without_const(self) -> ConstnessAnd<Self>[src]

impl<'a, T> Captures<'a> for T where
    T: ?Sized