Enum Pattern 

pub enum Pattern {
    Wildcard,
    Literal(Literal),
    Identifier(String),
    QualifiedName(Vec<String>),
    Tuple(Vec<Pattern>),
    List(Vec<Pattern>),
    Struct {
        name: String,
        fields: Vec<StructPatternField>,
        has_rest: bool,
    },
    TupleVariant {
        path: Vec<String>,
        patterns: Vec<Pattern>,
    },
    Range {
        start: Box<Pattern>,
        end: Box<Pattern>,
        inclusive: bool,
    },
    Or(Vec<Pattern>),
    Rest,
    RestNamed(String),
    AtBinding {
        name: String,
        pattern: Box<Pattern>,
    },
    WithDefault {
        pattern: Box<Pattern>,
        default: Box<Expr>,
    },
    Mut(Box<Pattern>),
    Ok(Box<Pattern>),
    Err(Box<Pattern>),
    Some(Box<Pattern>),
    None,
}

Patterns for destructuring and matching values.

Patterns are used in match expressions, let bindings, function parameters, and other contexts where values need to be destructured or tested against a structure. Ruchy supports a rich pattern language including literals, destructuring, ranges, and alternative patterns.

Pattern Types

• Wildcard: _ matches anything
• Literal: Matches exact values
• Identifier: Binds matched value to a name
• Tuple/List: Destructures sequences
• Struct: Destructures struct fields
• Or: Matches any of several patterns
• Rest: Captures remaining elements

Examples

match value {
    0 => "zero",                    // Literal pattern
    1..=10 => "small",              // Range pattern
    Some(x) => format!("value: {x}"), // Enum pattern
    [first, ..rest] => "list",     // List pattern with rest
    _ => "other",                   // Wildcard
}

Variants

Wildcard

Literal(Literal)

Identifier(String)

QualifiedName(Vec<String>)

Tuple(Vec<Pattern>)

List(Vec<Pattern>)

Struct

Fields

name: String

fields: Vec<StructPatternField>

has_rest: bool

TupleVariant

Fields

path: Vec<String>

patterns: Vec<Pattern>

Range

Fields

start: Box<Pattern>

end: Box<Pattern>

inclusive: bool

Or(Vec<Pattern>)

Rest

RestNamed(String)

AtBinding

Fields

name: String

pattern: Box<Pattern>

WithDefault

Fields

pattern: Box<Pattern>

default: Box<Expr>

Mut(Box<Pattern>)

Ok(Box<Pattern>)

Err(Box<Pattern>)

Some(Box<Pattern>)

None

Implementations

impl Pattern

pub fn primary_name(&self) -> String

Get the primary identifier name from this pattern. For complex patterns, returns the first/most significant identifier.

Trait Implementations

impl Clone for Pattern

fn clone(&self) -> Pattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pattern

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Pattern

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Pattern

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Pattern

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 Pattern