Struct syntax::ast::Attribute

pub struct Attribute {
    pub id: AttrId,
    pub style: AttrStyle,
    pub path: Path,
    pub tokens: TokenStream,
    pub is_sugared_doc: bool,
    pub span: Span,
}

Metadata associated with an item. Doc-comments are promoted to attributes that have is_sugared_doc = true.

Fields

id: AttrId

style: AttrStyle

path: Path

tokens: TokenStream

is_sugared_doc: bool

span: Span

Methods

impl Attribute

pub fn check_name(&self, name: &str) -> bool

pub fn name(&self) -> Name

Returns the last segment of the name of this attribute. e.g., foo for #[foo], skip for #[rustfmt::skip].

pub fn value_str(&self) -> Option<Symbol>

pub fn meta_item_list(&self) -> Option<Vec<NestedMetaItem>>

pub fn is_word(&self) -> bool

pub fn span(&self) -> Span

pub fn is_meta_item_list(&self) -> bool

pub fn is_value_str(&self) -> bool

Indicates if the attribute is a Value String.

impl Attribute

pub fn meta(&self) -> Option<MetaItem>

Extract the MetaItem from inside this Attribute.

pub fn parse<'a, T, F>(&self, sess: &'a ParseSess, f: F) -> PResult<'a, T> where
    F: FnMut(&mut Parser<'a>) -> PResult<'a, T>, 

pub fn parse_list<'a, T, F>(
    &self,
    sess: &'a ParseSess,
    f: F
) -> PResult<'a, Vec<T>> where
    F: FnMut(&mut Parser<'a>) -> PResult<'a, T>, 

pub fn parse_meta<'a>(&self, sess: &'a ParseSess) -> PResult<'a, MetaItem>

pub fn with_desugared_doc<T, F>(&self, f: F) -> T where
    F: FnOnce(&Attribute) -> T, 

Convert self to a normal #[doc="foo"] comment, if it is a comment like /// or /** */. (Returns self unchanged for non-sugared doc attributes.)

Trait Implementations

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attribute

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

Formats the value using the given formatter.

impl Encodable for Attribute

fn encode<__S: Encoder>(&self, s: &mut __S) -> Result<(), __S::Error>

impl Decodable for Attribute

fn decode<__D: Decoder>(d: &mut __D) -> Result<Attribute, __D::Error>