Enum PatKind 

pub enum PatKind {
    Wild,
    Ascription {
        pat: Pat,
        ty: SpannedTy,
    },
    Or {
        sub_pats: Vec<Pat>,
    },
    Array {
        args: Vec<Pat>,
    },
    Deref {
        sub_pat: Pat,
    },
    Constant {
        lit: Literal,
    },
    Binding {
        mutable: bool,
        var: LocalId,
        mode: BindingMode,
        sub_pat: Option<Pat>,
    },
    Construct {
        constructor: GlobalId,
        is_record: bool,
        is_struct: bool,
        fields: Vec<(GlobalId, Pat)>,
    },
    Resugared(ResugaredPatKind),
    Error(ErrorNode),
}

Represents the various kinds of patterns.

Variants

Wild

Wildcard pattern

Example:

_

Ascription

An ascription pattern

Example:

p : ty

Fields

pat: Pat

The inner pattern (p in the example)

ty: SpannedTy

The (spanned) type ascription (ty in the example)

Or

An or pattern

Example:

p | q Always contains at least 2 sub-patterns

Fields

sub_pats: Vec<Pat>

A vector of sub-patterns

Array

An array pattern

Example:

[p, q]

Fields

args: Vec<Pat>

A vector of patterns

Deref

A dereference pattern

Example:

&p

Fields

sub_pat: Pat

The inner pattern

Constant

A constant pattern

Example:

1

Fields

lit: Literal

The literal

Binding

A variable binding.

Examples:

• x → mutable: false
• mut x → mutable: true
• ref x → mode: ByRef(Shared)

Fields

mutable: bool

Is the binding mutable? E.g. x is not mutable, mut x is.

var: LocalId

The variable introduced by the binding pattern.

mode: BindingMode

The binding mode, e.g. [BindingMode::Shared] for ref x.

sub_pat: Option<Pat>

The sub-pattern, if any. For example, this is Some(inner_pat) for the pattern variable @ inner_pat.

Construct

A constructor pattern

Example:

Foo(x)

Fields

constructor: GlobalId

The identifier of the constructor we are matching

is_record: bool

Are we constructing a record? E.g. a struct or a variant with named fields.

is_struct: bool

Is this a struct? (meaning, not a variant from an enum)

fields: Vec<(GlobalId, Pat)>

A list of fields.

Resugared(ResugaredPatKind)

A resugared pattern. This variant is introduced before printing only. Phases must not produce this variant.

Error(ErrorNode)

Fallback constructor to carry errors.

Implementations

impl PatKind

pub fn var_pat(var: LocalId) -> Self

Pattern for binding to a single variable

pub fn promote(self, ty: Ty, span: Span) -> Pat

Promote to a Pat

Trait Implementations

impl AnyFragment for PatKind

fn type_id() -> FragmentTypeId

Get a type identifier for this fragment.

fn as_fragment<'a>(&'a self, type_id: FragmentTypeId) -> Option<FragmentRef<'a>>

Coerce as a fragment reference.

fn as_owned_fragment(&self, type_id: FragmentTypeId) -> Option<Fragment>

Coerce as an owned fragment.

impl AstVisitable for PatKind

fn drive_map<V: AstVisitorMut>(&mut self, v: &mut V)

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

fn drive<V: AstVisitor>(&self, v: &mut V)

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

impl AstVisitable for PatKind

fn drive<V: AstEarlyExitVisitor>(&self, v: &mut V) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

fn drive_mut<V: AstEarlyExitVisitorMut>( &mut self, v: &mut V, ) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

impl Clone for PatKind

fn clone(&self) -> PatKind

Returns a duplicate 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<'de> Deserialize<'de> for PatKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'s, V> Drive<'s, V> for PatKind

where V: Visitor + Visit<'s, Pat> + Visit<'s, SpannedTy> + Visit<'s, Vec<Pat>> + Visit<'s, Literal> + Visit<'s, bool> + Visit<'s, LocalId> + Visit<'s, BindingMode> + Visit<'s, Option<Pat>> + Visit<'s, GlobalId> + Visit<'s, Vec<(GlobalId, Pat)>> + Visit<'s, ResugaredPatKind> + Visit<'s, ErrorNode>,

fn drive_inner(&'s self, visitor: &mut V) -> ControlFlow<V::Break>

Call v.visit() on the immediate contents of self.

impl<'s, V> DriveMut<'s, V> for PatKind

where V: Visitor + VisitMut<'s, Pat> + VisitMut<'s, SpannedTy> + VisitMut<'s, Vec<Pat>> + VisitMut<'s, Literal> + VisitMut<'s, bool> + VisitMut<'s, LocalId> + VisitMut<'s, BindingMode> + VisitMut<'s, Option<Pat>> + VisitMut<'s, GlobalId> + VisitMut<'s, Vec<(GlobalId, Pat)>> + VisitMut<'s, ResugaredPatKind> + VisitMut<'s, ErrorNode>,

fn drive_inner_mut(&'s mut self, visitor: &mut V) -> ControlFlow<V::Break>

Call v.visit() on the immediate contents of self.

impl Eq for PatKind

impl<'lt> From<&'lt PatKind> for FragmentRef<'lt>

fn from(fragment: &'lt PatKind) -> Self

Converts to this type from the input type.

impl From<PatKind> for Fragment

fn from(fragment: PatKind) -> Self

Converts to this type from the input type.

impl Hash for PatKind

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for PatKind

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for PatKind

fn cmp(&self, other: &PatKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PatKind

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PatKind

fn partial_cmp(&self, other: &PatKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PatKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PatKind