# Enum syn::Pat [−] [src]

    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),
        // some variants omitted
    }

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

`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

### `impl Clone for Pat` [src]

#### `fn clone(&self) -> Self` [src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl From<PatBox> for Pat` [src]

#### `fn from(e: PatBox) -> Pat` [src]

Performs the conversion.

### `impl From<PatIdent> for Pat` [src]

#### `fn from(e: PatIdent) -> Pat` [src]

Performs the conversion.

### `impl From<PatLit> for Pat` [src]

#### `fn from(e: PatLit) -> Pat` [src]

Performs the conversion.

### `impl From<PatMacro> for Pat` [src]

#### `fn from(e: PatMacro) -> Pat` [src]

Performs the conversion.

### `impl From<PatOr> for Pat` [src]

#### `fn from(e: PatOr) -> Pat` [src]

Performs the conversion.

### `impl From<PatPath> for Pat` [src]

#### `fn from(e: PatPath) -> Pat` [src]

Performs the conversion.

### `impl From<PatRange> for Pat` [src]

#### `fn from(e: PatRange) -> Pat` [src]

Performs the conversion.

### `impl From<PatReference> for Pat` [src]

#### `fn from(e: PatReference) -> Pat` [src]

Performs the conversion.

### `impl From<PatRest> for Pat` [src]

#### `fn from(e: PatRest) -> Pat` [src]

Performs the conversion.

### `impl From<PatSlice> for Pat` [src]

#### `fn from(e: PatSlice) -> Pat` [src]

Performs the conversion.

### `impl From<PatStruct> for Pat` [src]

#### `fn from(e: PatStruct) -> Pat` [src]

Performs the conversion.

### `impl From<PatTuple> for Pat` [src]

#### `fn from(e: PatTuple) -> Pat` [src]

Performs the conversion.

### `impl From<PatTupleStruct> for Pat` [src]

#### `fn from(e: PatTupleStruct) -> Pat` [src]

Performs the conversion.

### `impl From<PatType> for Pat` [src]

#### `fn from(e: PatType) -> Pat` [src]

Performs the conversion.

### `impl From<PatWild> for Pat` [src]

#### `fn from(e: PatWild) -> Pat` [src]

Performs the conversion.

### `impl Parse for Pat` [src]

#### `fn parse(input: ParseStream<'_>) -> Result<Self>` [src]

### `impl ToTokens for Pat` [src]

#### `fn to_tokens(&self, tokens: &mut TokenStream)` [src]

Write `self` to the given `TokenStream`. Read more

#### `pub fn to_token_stream(&self) -> TokenStream` [src]

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

#### `pub fn into_token_stream(self) -> TokenStream` [src]

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

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> Spanned for T where
T: Spanned + ?Sized,` [src]

#### `pub fn span(&Self) -> Span` [src]

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

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

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

#### `pub fn clone_into(&self, target: &mut T)` [src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

recently added

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

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.