Enum rustc_ast::ast::PatKind

pub enum PatKind {
    Wild,
    Ident(BindingMode, Ident, Option<P<Pat>>),
    Struct(Option<P<QSelf>>, Path, ThinVec<PatField>, PatFieldsRest),
    TupleStruct(Option<P<QSelf>>, Path, ThinVec<P<Pat>>),
    Or(ThinVec<P<Pat>>),
    Path(Option<P<QSelf>>, Path),
    Tuple(ThinVec<P<Pat>>),
    Box(P<Pat>),
    Deref(P<Pat>),
    Ref(P<Pat>, Mutability),
    Lit(P<Expr>),
    Range(Option<P<Expr>>, Option<P<Expr>>, Spanned<RangeEnd>),
    Slice(ThinVec<P<Pat>>),
    Rest,
    Never,
    Paren(P<Pat>),
    MacCall(P<MacCall>),
    Err(ErrorGuaranteed),
}

All the different flavors of pattern that Rust recognizes.

Variants

Wild

Represents a wildcard pattern (_).

Ident(BindingMode, Ident, Option<P<Pat>>)

A PatKind::Ident may either be a new bound variable (ref mut binding @ OPT_SUBPATTERN), or a unit struct/variant pattern, or a const pattern (in the last two cases the third field must be None). Disambiguation cannot be done with parser alone, so it happens during name resolution.

Struct(Option<P<QSelf>>, Path, ThinVec<PatField>, PatFieldsRest)

A struct or struct variant pattern (e.g., Variant {x, y, ..}).

TupleStruct(Option<P<QSelf>>, Path, ThinVec<P<Pat>>)

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

Or(ThinVec<P<Pat>>)

An or-pattern A | B | C. Invariant: pats.len() >= 2.

Path(Option<P<QSelf>>, Path)

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

Tuple(ThinVec<P<Pat>>)

A tuple pattern ((a, b)).

Box(P<Pat>)

A box pattern.

Deref(P<Pat>)

A deref pattern (currently deref!() macro-based syntax).

Ref(P<Pat>, Mutability)

A reference pattern (e.g., &mut (a, b)).

Lit(P<Expr>)

A literal.

Range(Option<P<Expr>>, Option<P<Expr>>, Spanned<RangeEnd>)

A range pattern (e.g., 1...2, 1..2, 1.., ..2, 1..=2, ..=2).

Slice(ThinVec<P<Pat>>)

A slice pattern [a, b, c].

Rest

A rest pattern ...

Syntactically it is valid anywhere.

Semantically however, it only has meaning immediately inside:

• a slice pattern: [a, .., b],
• a binding pattern immediately inside a slice pattern: [a, r @ ..],
• a tuple pattern: (a, .., b),
• a tuple struct/variant pattern: $path(a, .., b).

In all of these cases, an additional restriction applies, only one rest pattern may occur in the pattern sequences.

Never

Paren(P<Pat>)

Parentheses in patterns used for grouping (i.e., (PAT)).

MacCall(P<MacCall>)

A macro pattern; pre-expansion.

Err(ErrorGuaranteed)

Placeholder for a pattern that wasn’t syntactically well formed in some way.

Trait Implementations

impl Clone for PatKind

fn clone(&self) -> PatKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PatKind

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

Formats the value using the given formatter.

impl<__D: SpanDecoder> Decodable<__D> for PatKind

fn decode(__decoder: &mut __D) -> Self

impl<__E: SpanEncoder> Encodable<__E> for PatKind

fn encode(&self, __encoder: &mut __E)

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 48 bytes

Size for each variant:

• Wild: 0 bytes
• Ident: 23 bytes
• Struct: 47 bytes
• TupleStruct: 47 bytes
• Or: 15 bytes
• Path: 39 bytes
• Tuple: 15 bytes
• Box: 15 bytes
• Deref: 15 bytes
• Ref: 15 bytes
• Lit: 15 bytes
• Range: 31 bytes
• Slice: 15 bytes
• Rest: 0 bytes
• Never: 0 bytes
• Paren: 15 bytes
• MacCall: 15 bytes
• Err: 0 bytes