Trait syn::synom::Synom

pub trait Synom: Sized {
    fn parse(input: Cursor) -> PResult<Self>;

    fn description() -> Option<&'static str> { ... }
}

Parsing interface implemented by all types that can be parsed in a default way from a token stream.

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

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

Required methods

fn parse(input: Cursor) -> PResult<Self>

Loading content...

Provided methods

fn description() -> Option<&'static str>

A short name of the type being parsed.

The description should only be used for a simple name. It should not contain newlines or sentence-ending punctuation, to facilitate embedding in larger user-facing strings. Syn will use this description when building error messages about parse failures.

Examples

struct ExprMacro {
    // ...
}

impl Synom for ExprMacro {
    // fn parse(...) -> ... { ... }

    fn description() -> Option<&'static str> {
        // Will result in messages like
        //
        //     "failed to parse macro invocation expression: $reason"
        Some("macro invocation expression")
    }
}

Loading content...

Implementations on Foreign Types

impl Synom for TokenStream

fn parse(input: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

Loading content...

Implementors

impl Synom for BareFnArgName

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for Expr

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for GenericArgument

fn parse(i: Cursor) -> PResult<Self>

impl Synom for GenericParam

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for Lit

fn parse(input: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for ReturnType

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TraitBoundModifier

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for syn::Type

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypeParamBound

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for UnOp

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for Visibility

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for WherePredicate

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for Abi

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for AngleBracketedGenericArguments

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for BareFnArg

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for Binding

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for BoundLifetimes

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for ConstParam

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for DeriveInput

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for ExprLit

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for ExprParen

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for ExprPath

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for FieldsNamed

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for FieldsUnnamed

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for Generics

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for Ident

fn parse(input: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for Lifetime

fn parse(input: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for LifetimeDef

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for LitBool

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for LitByte

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for LitByteStr

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for LitChar

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for LitFloat

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for LitInt

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for LitStr

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for syn::Macro

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for ParenthesizedGenericArguments

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for Path

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for PathSegment

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TraitBound

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypeArray

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypeBareFn

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypeGroup

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypeImplTrait

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypeInfer

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypeMacro

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypeNever

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypeParam

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypeParen

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypePath

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypePtr

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypeReference

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypeSlice

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypeTraitObject

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for TypeTuple

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for Variant

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for WhereClause

fn parse(i: Cursor) -> PResult<Self>

fn description() -> Option<&'static str>

impl Synom for Add

fn parse(tokens: Cursor) -> PResult<Add>

fn description() -> Option<&'static str>

impl Synom for AddEq

fn parse(tokens: Cursor) -> PResult<AddEq>

fn description() -> Option<&'static str>

impl Synom for And

fn parse(tokens: Cursor) -> PResult<And>

fn description() -> Option<&'static str>

impl Synom for AndAnd

fn parse(tokens: Cursor) -> PResult<AndAnd>

fn description() -> Option<&'static str>

impl Synom for AndEq

fn parse(tokens: Cursor) -> PResult<AndEq>

fn description() -> Option<&'static str>

impl Synom for As

fn parse(tokens: Cursor) -> PResult<As>

fn description() -> Option<&'static str>

impl Synom for At

fn parse(tokens: Cursor) -> PResult<At>

fn description() -> Option<&'static str>

impl Synom for Auto

fn parse(tokens: Cursor) -> PResult<Auto>

fn description() -> Option<&'static str>

impl Synom for Bang

fn parse(tokens: Cursor) -> PResult<Bang>

fn description() -> Option<&'static str>

impl Synom for Box

fn parse(tokens: Cursor) -> PResult<Box>

fn description() -> Option<&'static str>

impl Synom for Break

fn parse(tokens: Cursor) -> PResult<Break>

fn description() -> Option<&'static str>

impl Synom for CapSelf

fn parse(tokens: Cursor) -> PResult<CapSelf>

fn description() -> Option<&'static str>

impl Synom for Caret

fn parse(tokens: Cursor) -> PResult<Caret>

fn description() -> Option<&'static str>

impl Synom for CaretEq

fn parse(tokens: Cursor) -> PResult<CaretEq>

fn description() -> Option<&'static str>

impl Synom for Catch

fn parse(tokens: Cursor) -> PResult<Catch>

fn description() -> Option<&'static str>

impl Synom for Colon

fn parse(tokens: Cursor) -> PResult<Colon>

fn description() -> Option<&'static str>

impl Synom for Colon2

fn parse(tokens: Cursor) -> PResult<Colon2>

fn description() -> Option<&'static str>

impl Synom for Comma

fn parse(tokens: Cursor) -> PResult<Comma>

fn description() -> Option<&'static str>

impl Synom for Const

fn parse(tokens: Cursor) -> PResult<Const>

fn description() -> Option<&'static str>

impl Synom for Continue

fn parse(tokens: Cursor) -> PResult<Continue>

fn description() -> Option<&'static str>

impl Synom for Crate

fn parse(tokens: Cursor) -> PResult<Crate>

fn description() -> Option<&'static str>

impl Synom for Default

fn parse(tokens: Cursor) -> PResult<Default>

fn description() -> Option<&'static str>

impl Synom for Div

fn parse(tokens: Cursor) -> PResult<Div>

fn description() -> Option<&'static str>

impl Synom for DivEq

fn parse(tokens: Cursor) -> PResult<DivEq>

fn description() -> Option<&'static str>

impl Synom for Do

fn parse(tokens: Cursor) -> PResult<Do>

fn description() -> Option<&'static str>

impl Synom for Dot

fn parse(tokens: Cursor) -> PResult<Dot>

fn description() -> Option<&'static str>

impl Synom for Dot2

fn parse(tokens: Cursor) -> PResult<Dot2>

fn description() -> Option<&'static str>

impl Synom for Dot3

fn parse(tokens: Cursor) -> PResult<Dot3>

fn description() -> Option<&'static str>

impl Synom for DotDotEq

fn parse(tokens: Cursor) -> PResult<DotDotEq>

fn description() -> Option<&'static str>

impl Synom for Dyn

fn parse(tokens: Cursor) -> PResult<Dyn>

fn description() -> Option<&'static str>

impl Synom for Else

fn parse(tokens: Cursor) -> PResult<Else>

fn description() -> Option<&'static str>

impl Synom for Enum

fn parse(tokens: Cursor) -> PResult<Enum>

fn description() -> Option<&'static str>

impl Synom for Eq

fn parse(tokens: Cursor) -> PResult<Eq>

fn description() -> Option<&'static str>

impl Synom for EqEq

fn parse(tokens: Cursor) -> PResult<EqEq>

fn description() -> Option<&'static str>

impl Synom for Extern

fn parse(tokens: Cursor) -> PResult<Extern>

fn description() -> Option<&'static str>

impl Synom for Fn

fn parse(tokens: Cursor) -> PResult<Fn>

fn description() -> Option<&'static str>

impl Synom for For

fn parse(tokens: Cursor) -> PResult<For>

fn description() -> Option<&'static str>

impl Synom for Ge

fn parse(tokens: Cursor) -> PResult<Ge>

fn description() -> Option<&'static str>

impl Synom for Gt

fn parse(tokens: Cursor) -> PResult<Gt>

fn description() -> Option<&'static str>

impl Synom for If

fn parse(tokens: Cursor) -> PResult<If>

fn description() -> Option<&'static str>

impl Synom for Impl

fn parse(tokens: Cursor) -> PResult<Impl>

fn description() -> Option<&'static str>

impl Synom for In

fn parse(tokens: Cursor) -> PResult<In>

fn description() -> Option<&'static str>

impl Synom for LArrow

fn parse(tokens: Cursor) -> PResult<LArrow>

fn description() -> Option<&'static str>

impl Synom for Le

fn parse(tokens: Cursor) -> PResult<Le>

fn description() -> Option<&'static str>

impl Synom for Let

fn parse(tokens: Cursor) -> PResult<Let>

fn description() -> Option<&'static str>

impl Synom for Loop

fn parse(tokens: Cursor) -> PResult<Loop>

fn description() -> Option<&'static str>

impl Synom for Lt

fn parse(tokens: Cursor) -> PResult<Lt>

fn description() -> Option<&'static str>

impl Synom for syn::token::Macro

fn parse(tokens: Cursor) -> PResult<Macro>

fn description() -> Option<&'static str>

impl Synom for Match

fn parse(tokens: Cursor) -> PResult<Match>

fn description() -> Option<&'static str>

impl Synom for Mod

fn parse(tokens: Cursor) -> PResult<Mod>

fn description() -> Option<&'static str>

impl Synom for Move

fn parse(tokens: Cursor) -> PResult<Move>

fn description() -> Option<&'static str>

impl Synom for MulEq

fn parse(tokens: Cursor) -> PResult<MulEq>

fn description() -> Option<&'static str>

impl Synom for Mut

fn parse(tokens: Cursor) -> PResult<Mut>

fn description() -> Option<&'static str>

impl Synom for Ne

fn parse(tokens: Cursor) -> PResult<Ne>

fn description() -> Option<&'static str>

impl Synom for Or

fn parse(tokens: Cursor) -> PResult<Or>

fn description() -> Option<&'static str>

impl Synom for OrEq

fn parse(tokens: Cursor) -> PResult<OrEq>

fn description() -> Option<&'static str>

impl Synom for OrOr

fn parse(tokens: Cursor) -> PResult<OrOr>

fn description() -> Option<&'static str>

impl Synom for Pound

fn parse(tokens: Cursor) -> PResult<Pound>

fn description() -> Option<&'static str>

impl Synom for Pub

fn parse(tokens: Cursor) -> PResult<Pub>

fn description() -> Option<&'static str>

impl Synom for Question

fn parse(tokens: Cursor) -> PResult<Question>

fn description() -> Option<&'static str>

impl Synom for RArrow

fn parse(tokens: Cursor) -> PResult<RArrow>

fn description() -> Option<&'static str>

impl Synom for Ref

fn parse(tokens: Cursor) -> PResult<Ref>

fn description() -> Option<&'static str>

impl Synom for Rem

fn parse(tokens: Cursor) -> PResult<Rem>

fn description() -> Option<&'static str>

impl Synom for RemEq

fn parse(tokens: Cursor) -> PResult<RemEq>

fn description() -> Option<&'static str>

impl Synom for Return

fn parse(tokens: Cursor) -> PResult<Return>

fn description() -> Option<&'static str>

impl Synom for Rocket

fn parse(tokens: Cursor) -> PResult<Rocket>

fn description() -> Option<&'static str>

impl Synom for Self_

fn parse(tokens: Cursor) -> PResult<Self_>

fn description() -> Option<&'static str>

impl Synom for Semi

fn parse(tokens: Cursor) -> PResult<Semi>

fn description() -> Option<&'static str>

impl Synom for Shl

fn parse(tokens: Cursor) -> PResult<Shl>

fn description() -> Option<&'static str>

impl Synom for ShlEq

fn parse(tokens: Cursor) -> PResult<ShlEq>

fn description() -> Option<&'static str>

impl Synom for Shr

fn parse(tokens: Cursor) -> PResult<Shr>

fn description() -> Option<&'static str>

impl Synom for ShrEq

fn parse(tokens: Cursor) -> PResult<ShrEq>

fn description() -> Option<&'static str>

impl Synom for Star

fn parse(tokens: Cursor) -> PResult<Star>

fn description() -> Option<&'static str>

impl Synom for Static

fn parse(tokens: Cursor) -> PResult<Static>

fn description() -> Option<&'static str>

impl Synom for Struct

fn parse(tokens: Cursor) -> PResult<Struct>

fn description() -> Option<&'static str>

impl Synom for Sub

fn parse(tokens: Cursor) -> PResult<Sub>

fn description() -> Option<&'static str>

impl Synom for SubEq

fn parse(tokens: Cursor) -> PResult<SubEq>

fn description() -> Option<&'static str>

impl Synom for Super

fn parse(tokens: Cursor) -> PResult<Super>

fn description() -> Option<&'static str>

impl Synom for Trait

fn parse(tokens: Cursor) -> PResult<Trait>

fn description() -> Option<&'static str>

impl Synom for syn::token::Type

fn parse(tokens: Cursor) -> PResult<Type>

fn description() -> Option<&'static str>

impl Synom for Underscore

fn parse(tokens: Cursor) -> PResult<Underscore>

fn description() -> Option<&'static str>

impl Synom for Union

fn parse(tokens: Cursor) -> PResult<Union>

fn description() -> Option<&'static str>

impl Synom for Unsafe

fn parse(tokens: Cursor) -> PResult<Unsafe>

fn description() -> Option<&'static str>

impl Synom for Use

fn parse(tokens: Cursor) -> PResult<Use>

fn description() -> Option<&'static str>

impl Synom for Where

fn parse(tokens: Cursor) -> PResult<Where>

fn description() -> Option<&'static str>

impl Synom for While

fn parse(tokens: Cursor) -> PResult<While>

fn description() -> Option<&'static str>

impl Synom for Yield

fn parse(tokens: Cursor) -> PResult<Yield>

fn description() -> Option<&'static str>

Loading content...