Struct Attribute

pub struct Attribute {
    pub pound_token: Pound,
    pub style: AttrStyle,
    pub bracket_token: Bracket,
    pub path: Path,
    pub tts: TokenStream,
}

An attribute like #[repr(transparent)].

This type is available if Syn is built with the "derive" or "full" feature.

Syntax

Rust has six types of attributes.

• Outer attributes like #[repr(transparent)]. These appear outside or in front of the item they describe.
• Inner attributes like #![feature(proc_macro)]. These appear inside of the item they describe, usually a module.
• Outer doc comments like /// # Example.
• Inner doc comments like //! Please file an issue.
• Outer block comments /** # Example */.
• Inner block comments /*! Please file an issue */.

The style field of type AttrStyle distinguishes whether an attribute is outer or inner. Doc comments and block comments are promoted to attributes, as this is how they are processed by the compiler and by macro_rules! macros.

The path field gives the possibly colon-delimited path against which the attribute is resolved. It is equal to "doc" for desugared doc comments. The tts field contains the rest of the attribute body as tokens.

#[derive(Copy)]      #[crate::precondition x < 5]
  ^^^^^^~~~~~~         ^^^^^^^^^^^^^^^^^^^ ~~~~~
   path  tts                   path         tts

Use the parse_meta method to try parsing the tokens of an attribute into the structured representation that is used by convention across most Rust libraries.

Parsing

This type does not implement the Parse trait and thus cannot be parsed directly by ParseStream::parse. Instead use ParseStream::call with one of the two parser functions Attribute::parse_outer or Attribute::parse_inner depending on which you intend to parse.

use syn::{Attribute, Ident, Result, Token};
use syn::parse::{Parse, ParseStream};

// Parses a unit struct with attributes.
//
//     #[path = "s.tmpl"]
//     struct S;
struct UnitStruct {
    attrs: Vec<Attribute>,
    struct_token: Token![struct],
    name: Ident,
    semi_token: Token![;],
}

impl Parse for UnitStruct {
    fn parse(input: ParseStream) -> Result<Self> {
        Ok(UnitStruct {
            attrs: input.call(Attribute::parse_outer)?,
            struct_token: input.parse()?,
            name: input.parse()?,
            semi_token: input.parse()?,
        })
    }
}

Fields

pound_token: Pound

style: AttrStyle

bracket_token: Bracket

path: Path

tts: TokenStream

Implementations

impl Attribute

pub fn parse_meta(&self) -> Result<Meta>

Parses the tokens after the path as a Meta if possible.

pub fn parse_outer(input: ParseStream<'_>) -> Result<Vec<Self>>

Parses zero or more outer attributes from the stream.

This function is available if Syn is built with the "parsing" feature.

pub fn parse_inner(input: ParseStream<'_>) -> Result<Vec<Self>>

Parses zero or more inner attributes from the stream.

This function is available if Syn is built with the "parsing" feature.

Trait Implementations

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a duplicate 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 Hash for Attribute

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Attribute

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToTokens for Attribute

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.

impl Eq for Attribute