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: Symbol) -> bool

Returns true if the attribute's path matches the argument. If it matches, then the attribute is marked as used.

To check the attribute name without marking it used, use the path field directly.

pub fn ident(&self) -> Option<Ident>

For a single-segment attribute returns its name, otherwise returns None.

pub fn name_or_empty(&self) -> Symbol

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

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

pub fn is_word(&self) -> bool

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>

Extracts 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, 

Converts 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>