Struct rustdoc::clean::types::Attributes

source ·
pub(crate) struct Attributes {
    pub(crate) doc_strings: Vec<DocFragment>,
    pub(crate) other_attrs: AttrVec,
}
Expand description

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

Fields§

§doc_strings: Vec<DocFragment>§other_attrs: AttrVec

Implementations§

source§

impl Attributes

source

pub(crate) fn lists( &self, name: Symbol ) -> impl Iterator<Item = NestedMetaItem> + '_

source

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

source

fn is_doc_hidden(&self) -> bool

source

pub(crate) fn from_ast(attrs: &[Attribute]) -> Attributes

source

pub(crate) fn from_ast_with_additional( attrs: &[Attribute], (additional_attrs, def_id): (&[Attribute], DefId) ) -> Attributes

source

pub(crate) fn from_ast_iter<'a>( attrs: impl Iterator<Item = (&'a Attribute, Option<DefId>)>, doc_only: bool ) -> Attributes

source

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

Combine all doc strings into a single value handling indentation and newlines as needed.

source

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

Combine all doc strings into a single value handling indentation and newlines as needed. Returns None is there’s no documentation at all, and Some("") if there is some documentation but it is empty (e.g. #[doc = ""]).

source

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

Trait Implementations§

source§

impl Clone for Attributes

source§

fn clone(&self) -> Attributes

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Attributes

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Attributes

source§

fn default() -> Attributes

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

impl PartialEq<Attributes> for Attributes

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for Attributes

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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