# Enum syn::Pat

source · [−]

    #[non_exhaustive]
    pub enum Pat {
    Show 16 variants    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),
    }

Expand description

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)

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.

### `Box(PatBox)`

A box pattern: `box v`.

### `Ident(PatIdent)`

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

### `Lit(PatLit)`

A literal pattern: `0`.

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

### `Macro(PatMacro)`

A macro in pattern position.

### `Or(PatOr)`

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

### `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: `_`.

## 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 From<PatBox> for Pat

source

#### fn from(e: PatBox) -> 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<PatLit> for Pat

source

#### fn from(e: PatLit) -> Pat

Converts to this type from the input type.

source

### impl From<PatMacro> for Pat

source

#### fn from(e: PatMacro) -> 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<PatPath> for Pat

source

#### fn from(e: PatPath) -> Pat

Converts to this type from the input type.

source

### impl From<PatRange> for Pat

source

#### fn from(e: PatRange) -> 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 Parse for Pat

source

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

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

Convert `self` directly into a `TokenStream` object. Read more

## Auto Trait Implementations

### 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,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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. Read more

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.

const: unstable · 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.

const: unstable · source

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

Performs the conversion.