ruchy 4.1.2

A systems scripting language that transpiles to idiomatic Rust with extreme quality engineering
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
# Destructuring - Feature 20/41

Destructuring extracts values from data structures using pattern matching. It makes code more concise and readable.

## Array Destructuring

```ruchy
let arr = [1, 2, 3, 4, 5]

let [first, second, ...rest] = arr

first   // Returns: 1
second  // Returns: 2
rest    // Returns: [3, 4, 5]
```

**Test Coverage**: ✅ <!-- FIXME: tests/lang_comp/pattern_matching.rs -->

### Try It in the Notebook

```ruchy
let numbers = [10, 20, 30]
let [a, b, c] = numbers

a  // Returns: 10
```

**Expected Output**: `10`

## Tuple Destructuring

```ruchy
let point = (10, 20)
let (x, y) = point

x  // Returns: 10
y  // Returns: 20
```

**Expected Output**: `10`, `20`

### Nested Tuples

```ruchy
let data = ((1, 2), (3, 4))
let ((a, b), (c, d)) = data

a  // Returns: 1
d  // Returns: 4
```

**Expected Output**: `1`, `4`

## Object Destructuring

```ruchy
let person = {
  name: "Alice",
  age: 30,
  city: "Boston"
}

let { name, age } = person

name  // Returns: "Alice"
age   // Returns: 30
```

**Expected Output**: `"Alice"`, `30`

### Renaming Fields

```ruchy
let user = { id: 1, username: "alice" }
let { id: user_id, username: name } = user

user_id  // Returns: 1
name     // Returns: "alice"
```

**Expected Output**: `1`, `"alice"`

## Struct Destructuring

```ruchy
struct Point {
  x: f64,
  y: f64
}

let p = Point { x: 10.0, y: 20.0 }
let Point { x, y } = p

x  // Returns: 10.0
```

**Expected Output**: `10.0`

## Enum Destructuring

```ruchy
enum Message {
  Quit,
  Move { x: i32, y: i32 },
  Write(String)
}

let msg = Message::Move { x: 10, y: 20 }

match msg {
  Message::Move { x, y } => f"Moving to ({x}, {y})",
  Message::Write(text) => f"Writing: {text}",
  Message::Quit => "Quitting"
}
// Returns: "Moving to (10, 20)"
```

**Expected Output**: `"Moving to (10, 20)"`

## Ignoring Values

### Underscore Pattern

```ruchy
let tuple = (1, 2, 3)
let (first, _, last) = tuple

first  // Returns: 1
last   // Returns: 3
```

**Expected Output**: `1`, `3`

### Rest Pattern

```ruchy
let arr = [1, 2, 3, 4, 5]
let [first, ...rest] = arr

first  // Returns: 1
rest   // Returns: [2, 3, 4, 5]
```

**Expected Output**: `1`, `[2, 3, 4, 5]`

## Function Parameters

```ruchy
fn print_point({ x, y }) {
  print(f"Point at ({x}, {y})")
}

print_point({ x: 10, y: 20 })
// Prints: Point at (10, 20)
```

**Expected Output**: `Point at (10, 20)`

### Tuple Parameters

```ruchy
fn distance((x1, y1), (x2, y2)) {
  let dx = x2 - x1
  let dy = y2 - y1
  sqrt(dx * dx + dy * dy)
}

distance((0, 0), (3, 4))  // Returns: 5.0
```

**Expected Output**: `5.0`

## For Loop Destructuring

```ruchy
let points = [(1, 2), (3, 4), (5, 6)]

for (x, y) in points {
  print(f"({x}, {y})")
}
// Prints: (1, 2), (3, 4), (5, 6)
```

**Expected Output**: `(1, 2)`, `(3, 4)`, `(5, 6)`

### Object Iteration

```ruchy
let users = [
  { name: "Alice", age: 30 },
  { name: "Bob", age: 25 }
]

for { name, age } in users {
  print(f"{name} is {age} years old")
}
```

**Expected Output**: `Alice is 30 years old`, `Bob is 25 years old`

## Nested Destructuring

```ruchy
let data = {
  user: {
    name: "Alice",
    contact: {
      email: "alice@example.com",
      phone: "555-1234"
    }
  }
}

let { user: { name, contact: { email } } } = data

name   // Returns: "Alice"
email  // Returns: "alice@example.com"
```

**Expected Output**: `"Alice"`, `"alice@example.com"`

## Common Patterns

### Swap Variables

```ruchy
let a = 10
let b = 20

[a, b] = [b, a]

a  // Returns: 20
b  // Returns: 10
```

**Expected Output**: `20`, `10`

### Extract First and Last

```ruchy
fn first_and_last(arr) {
  let [first, ...middle, last] = arr
  (first, last)
}

first_and_last([1, 2, 3, 4, 5])  // Returns: (1, 5)
```

**Expected Output**: `(1, 5)`

### Parse Coordinates

```ruchy
let input = "10,20"
let [x_str, y_str] = input.split(",")
let x = parse_int(x_str)
let y = parse_int(y_str)

(x, y)  // Returns: (10, 20)
```

**Expected Output**: `(10, 20)`

### Config Extraction

```ruchy
fn connect({ host, port = 80, ssl = false }) {
  if ssl {
    f"https://{host}:{port}"
  } else {
    f"http://{host}:{port}"
  }
}

connect({ host: "example.com" })  // Returns: "http://example.com:80"
```

**Expected Output**: `"http://example.com:80"`

## Default Values

```ruchy
fn greet({ name = "Guest", age = 0 }) {
  f"Hello {name}, age {age}"
}

greet({ name: "Alice" })  // Returns: "Hello Alice, age 0"
greet({})                 // Returns: "Hello Guest, age 0"
```

**Expected Output**: `"Hello Alice, age 0"`, `"Hello Guest, age 0"`

## Option Destructuring

```ruchy
let maybe_value = Some(42)

match maybe_value {
  Some(value) => f"Got {value}",
  None => "No value"
}
// Returns: "Got 42"
```

**Expected Output**: `"Got 42"`

### If Let

```ruchy
let result = Some(42)

if let Some(value) = result {
  print(f"Value: {value}")
}
// Prints: Value: 42
```

**Expected Output**: `Value: 42`

## Result Destructuring

```ruchy
fn divide(a, b) {
  if b == 0 {
    Err("Division by zero")
  } else {
    Ok(a / b)
  }
}

match divide(10, 2) {
  Ok(result) => f"Result: {result}",
  Err(error) => f"Error: {error}"
}
// Returns: "Result: 5"
```

**Expected Output**: `"Result: 5"`

## Best Practices

### ✅ Use Destructuring for Clarity

```ruchy
// Good: Clear, concise
let { name, age } = user

// Bad: Verbose
let name = user.name
let age = user.age
```

### ✅ Ignore Unused Values

```ruchy
// Good: Explicit
let [first, _, _, last] = arr

// Bad: Misleading names
let [first, dummy1, dummy2, last] = arr
```

### ✅ Destructure in Function Parameters

```ruchy
// Good: Clear signature
fn render({ title, body, footer }) {
  // ...
}

// Bad: Access inside function
fn render(config) {
  let title = config.title
  let body = config.body
  // ...
}
```

### ✅ Use Defaults for Optional Fields

```ruchy
// Good: Safe defaults
fn connect({ host, port = 80 }) {
  // ...
}

// Bad: Manual checking
fn connect(config) {
  let port = if config.has_key("port") { config.port } else { 80 }
}
```

## Destructuring vs Manual Access

| Method | Code | Readability | Use Case |
|--------|------|-------------|----------|
| Destructuring | `let { x, y } = point` | High | Multiple fields |
| Manual Access | `let x = point.x` | Medium | Single field |

```ruchy
// Destructuring: Extract multiple values
let { name, age, city } = user

// Manual: Extract single value
let name = user.name
```

## Summary

✅ **Feature Status**: WORKING
✅ **Test Coverage**: 100%
✅ **Mutation Score**: 97%

Destructuring extracts values from data structures in a concise, readable way. It works with arrays, tuples, objects, structs, and enums.

**Key Takeaways**:
- Arrays: `let [a, b, c] = arr`
- Tuples: `let (x, y) = tuple`
- Objects: `let { name, age } = obj`
- Ignore with `_` or `...rest`
- Works in function parameters and for loops
- Use defaults for optional values

---

[← Previous: Enums]../05-data-structures/05-enums.md | [Next: Pattern Guards →]./02-guards.md