Enum syn::Pat

#[non_exhaustive]
pub enum Pat {
    Box(PatBox),
    Ident(PatIdent),
    Lit(PatLit),
    Macro(PatMacro),
    Or(PatOr),
    Path(PatPath),
    Range(PatRange),
    Reference(PatReference),
    Rest(PatRest),
    Slice(PatSlice),
    Struct(PatStruct),
    Tuple(PatTuple),
    TupleStruct(PatTupleStruct),
    Type(PatType),
    Verbatim(TokenStream),
    Wild(PatWild),
}

A pattern in a local binding, function signature, match expression, or various other places.

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

Syntax tree enum

This type is a syntax tree enum.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Box(PatBox)

Tuple Fields

0: PatBox

A box pattern: box v.

Ident(PatIdent)

Tuple Fields

0: PatIdent

A pattern that binds a new variable: ref mut binding @ SUBPATTERN.

Lit(PatLit)

Tuple Fields

0: PatLit

A literal pattern: 0.

This holds an Expr rather than a Lit because negative numbers are represented as an Expr::Unary.

Macro(PatMacro)

Tuple Fields

0: PatMacro

A macro in pattern position.

Or(PatOr)

Tuple Fields

0: PatOr

A pattern that matches any one of a set of cases.

Path(PatPath)

Tuple Fields

0: PatPath

A path pattern like Color::Red, optionally qualified with a self-type.

Unqualified path patterns can legally refer to variants, structs, constants or associated constants. Qualified path patterns like <A>::B::C and <A as Trait>::B::C can only legally refer to associated constants.

Range(PatRange)

Tuple Fields

0: PatRange

A range pattern: 1..=2.

Reference(PatReference)

Tuple Fields

0: PatReference

A reference pattern: &mut var.

Rest(PatRest)

Tuple Fields

0: PatRest

The dots in a tuple or slice pattern: [0, 1, ..]

Slice(PatSlice)

Tuple Fields

0: PatSlice

A dynamically sized slice pattern: [a, b, ref i @ .., y, z].

Struct(PatStruct)

Tuple Fields

0: PatStruct

A struct or struct variant pattern: Variant { x, y, .. }.

Tuple(PatTuple)

Tuple Fields

0: PatTuple

A tuple pattern: (a, b).

TupleStruct(PatTupleStruct)

Tuple Fields

0: PatTupleStruct

A tuple struct or tuple variant pattern: Variant(x, y, .., z).

Type(PatType)

Tuple Fields

0: PatType

A type ascription pattern: foo: f64.

Verbatim(TokenStream)

Tuple Fields

0: TokenStream

Tokens in pattern position not interpreted by Syn.

Wild(PatWild)

Tuple Fields

0: PatWild

A pattern that matches any value: _.

Trait Implementations

impl Clone for Pat

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pat

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<PatBox> for Pat

fn from(e: PatBox) -> Pat

Performs the conversion.

impl From<PatIdent> for Pat

fn from(e: PatIdent) -> Pat

Performs the conversion.

impl From<PatLit> for Pat

fn from(e: PatLit) -> Pat

Performs the conversion.

impl From<PatMacro> for Pat

fn from(e: PatMacro) -> Pat

Performs the conversion.

impl From<PatOr> for Pat

fn from(e: PatOr) -> Pat

Performs the conversion.

impl From<PatPath> for Pat

fn from(e: PatPath) -> Pat

Performs the conversion.

impl From<PatRange> for Pat

fn from(e: PatRange) -> Pat

Performs the conversion.

impl From<PatReference> for Pat

fn from(e: PatReference) -> Pat

Performs the conversion.

impl From<PatRest> for Pat

fn from(e: PatRest) -> Pat

Performs the conversion.

impl From<PatSlice> for Pat

fn from(e: PatSlice) -> Pat

Performs the conversion.

impl From<PatStruct> for Pat

fn from(e: PatStruct) -> Pat

Performs the conversion.

impl From<PatTuple> for Pat

fn from(e: PatTuple) -> Pat

Performs the conversion.

impl From<PatTupleStruct> for Pat

fn from(e: PatTupleStruct) -> Pat

Performs the conversion.

impl From<PatType> for Pat

fn from(e: PatType) -> Pat

Performs the conversion.

impl From<PatWild> for Pat

fn from(e: PatWild) -> Pat

Performs the conversion.

impl Hash for Pat

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, 

Feeds a slice of this type into the given Hasher.

impl Parse for Pat

fn parse(input: ParseStream<'_>) -> Result<Self>

impl PartialEq<Pat> for Pat

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl ToTokens for Pat

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

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

Convert self directly into a TokenStream object.

impl Eq for Pat