Enum syn::Pat

source ·
#[non_exhaustive]
pub enum Pat {
Show 17 variants Const(PatConst), Ident(PatIdent), Lit(PatLit), Macro(PatMacro), Or(PatOr), Paren(PatParen), Path(PatPath), Range(PatRange), Reference(PatReference), Rest(PatRest), Slice(PatSlice), Struct(PatStruct), Tuple(PatTuple), TupleStruct(PatTupleStruct), Type(PatType), Verbatim(TokenStream), Wild(PatWild),
}
Expand description

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

§Syntax tree enum

This type is a syntax tree enum.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Const(PatConst)

A const block: const { ... }.

§

Ident(PatIdent)

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

§

Lit(PatLit)

A literal pattern: 0.

§

Macro(PatMacro)

A macro in pattern position.

§

Or(PatOr)

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

§

Paren(PatParen)

A parenthesized pattern: (A | B).

§

Path(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)

A range pattern: 1..=2.

§

Reference(PatReference)

A reference pattern: &mut var.

§

Rest(PatRest)

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

§

Slice(PatSlice)

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

§

Struct(PatStruct)

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

§

Tuple(PatTuple)

A tuple pattern: (a, b).

§

TupleStruct(PatTupleStruct)

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

§

Type(PatType)

A type ascription pattern: foo: f64.

§

Verbatim(TokenStream)

Tokens in pattern position not interpreted by Syn.

§

Wild(PatWild)

A pattern that matches any value: _.

Implementations§

source§

impl Pat

source

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

Parse a pattern that does not involve | at the top level.

This parser matches the behavior of the $:pat_param macro_rules matcher, and on editions prior to Rust 2021, the behavior of $:pat.

In Rust syntax, some examples of where this syntax would occur are in the argument pattern of functions and closures. Patterns using | are not allowed to occur in these positions.

fn f(Some(_) | None: Option<T>) {
    let _ = |Some(_) | None: Option<T>| {};
    //       ^^^^^^^^^^^^^^^^^^^^^^^^^??? :(
}
error: top-level or-patterns are not allowed in function parameters
 --> src/main.rs:1:6
  |
1 | fn f(Some(_) | None: Option<T>) {
  |      ^^^^^^^^^^^^^^ help: wrap the pattern in parentheses: `(Some(_) | None)`
source

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

Parse a pattern, possibly involving |, but not a leading |.

source

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

Parse a pattern, possibly involving |, possibly including a leading |.

This parser matches the behavior of the Rust 2021 edition’s $:pat macro_rules matcher.

In Rust syntax, an example of where this syntax would occur is in the pattern of a match arm, where the language permits an optional leading |, although it is not idiomatic to write one there in handwritten code.

match wat {
    | None | Some(false) => {}
    | Some(true) => {}
}

The compiler accepts it only to facilitate some situations in macro-generated code where a macro author might need to write:

match $value {
    $(| $conditions1)* $(| $conditions2)* => $then
}

Expressing the same thing correctly in the case that either one (but not both) of $conditions1 and $conditions2 might be empty, without leading |, is complex.

Use Pat::parse_multi instead if you are not intending to support macro-generated macro input.

Trait Implementations§

source§

impl Clone for Pat

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Pat

source§

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

Formats the value using the given formatter. Read more
source§

impl From<ExprConst> for Pat

source§

fn from(e: PatConst) -> Pat

Converts to this type from the input type.
source§

impl From<ExprLit> for Pat

source§

fn from(e: PatLit) -> Pat

Converts to this type from the input type.
source§

impl From<ExprMacro> for Pat

source§

fn from(e: PatMacro) -> Pat

Converts to this type from the input type.
source§

impl From<ExprPath> for Pat

source§

fn from(e: PatPath) -> Pat

Converts to this type from the input type.
source§

impl From<ExprRange> for Pat

source§

fn from(e: PatRange) -> Pat

Converts to this type from the input type.
source§

impl From<PatIdent> for Pat

source§

fn from(e: PatIdent) -> Pat

Converts to this type from the input type.
source§

impl From<PatOr> for Pat

source§

fn from(e: PatOr) -> Pat

Converts to this type from the input type.
source§

impl From<PatParen> for Pat

source§

fn from(e: PatParen) -> Pat

Converts to this type from the input type.
source§

impl From<PatReference> for Pat

source§

fn from(e: PatReference) -> Pat

Converts to this type from the input type.
source§

impl From<PatRest> for Pat

source§

fn from(e: PatRest) -> Pat

Converts to this type from the input type.
source§

impl From<PatSlice> for Pat

source§

fn from(e: PatSlice) -> Pat

Converts to this type from the input type.
source§

impl From<PatStruct> for Pat

source§

fn from(e: PatStruct) -> Pat

Converts to this type from the input type.
source§

impl From<PatTuple> for Pat

source§

fn from(e: PatTuple) -> Pat

Converts to this type from the input type.
source§

impl From<PatTupleStruct> for Pat

source§

fn from(e: PatTupleStruct) -> Pat

Converts to this type from the input type.
source§

impl From<PatType> for Pat

source§

fn from(e: PatType) -> Pat

Converts to this type from the input type.
source§

impl From<PatWild> for Pat

source§

fn from(e: PatWild) -> Pat

Converts to this type from the input type.
source§

impl Hash for Pat

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for Pat

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl ToTokens for Pat

source§

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

Write self to the given TokenStream. Read more
source§

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object. Read more
source§

fn into_token_stream(self) -> TokenStream
where Self: Sized,

Convert self directly into a TokenStream object. Read more
source§

impl Eq for Pat

Auto Trait Implementations§

§

impl Freeze for Pat

§

impl RefUnwindSafe for Pat

§

impl !Send for Pat

§

impl !Sync for Pat

§

impl Unpin for Pat

§

impl UnwindSafe for Pat

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Spanned for T
where T: Spanned + ?Sized,

source§

fn span(&self) -> Span

Returns a Span covering the complete contents of this syntax tree node, or Span::call_site() if this node is empty.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.