Enum syn::Pat[−][src]

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

This is supported on crate feature full only.

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

`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

This is supported on crate feature clone-impls only.

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

impl Debug for Pat

This is supported on crate feature extra-traits only.

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

Formats the value using the given formatter. Read more

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

This is supported on crate feature extra-traits only.

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

Feeds this value into the given Hasher. Read more

1.3.0[src]

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

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

impl Parse for Pat

This is supported on crate feature parsing only.

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

impl PartialEq<Pat> for Pat

This is supported on crate feature extra-traits only.

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

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

1.0.0[src]

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

This method tests for !=.

impl ToTokens for Pat

This is supported on crate feature printing only.

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

Write self to the given TokenStream. Read more

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object. Read more

fn into_token_stream(self) -> TokenStream

Convert self directly into a TokenStream object. Read more

impl Eq for Pat

This is supported on crate feature extra-traits only.

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,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

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

pub fn into(self) -> U

Performs the conversion.

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

pub fn span(&Self) -> Span

This is supported on crate features parsing and printing only.

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,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

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

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

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

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

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

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>

Performs the conversion.

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.

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

Performs the conversion.