Trait Parser

pub trait Parser: Sized {
    type Output;

    // Required method
    fn parse2(self, tokens: TokenStream) -> Result<Self::Output, ParseError>;

    // Provided methods
    fn parse(self, tokens: TokenStream) -> Result<Self::Output, ParseError> { ... }
    fn parse_str(self, s: &str) -> Result<Self::Output, ParseError> { ... }
}

Parser that can parse Rust tokens into a particular syntax tree node.

Refer to the module documentation for details about parsing in Syn.

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

Required Associated Types

type Output

Required Methods

fn parse2(self, tokens: TokenStream) -> Result<Self::Output, ParseError>

Parse a proc-macro2 token stream into the chosen syntax tree node.

Provided Methods

fn parse(self, tokens: TokenStream) -> Result<Self::Output, ParseError>

Parse tokens of source code into the chosen syntax tree node.

fn parse_str(self, s: &str) -> Result<Self::Output, ParseError>

Parse a string of Rust code into the chosen syntax tree node.

Hygiene

Every span in the resulting syntax tree will be set to resolve at the macro call site.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<F, T> Parser for F

where F: FnOnce(Cursor<'_>) -> PResult<'_, T>,

type Output = T