summaryrefslogtreecommitdiff
path: root/docs/type_system/fn.md
blob: dce371d32d2dd5865fed82d5ef1d743be8633dce (plain)
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
# Fn

---

```text
Fn_class `alias Enum[.partial; .complete; .iterator; .closure; .bound; .regex; .native]

Fn[Fn_class; RETURN_TYPE; ARGS; STATE; List]
```

## \`return

## Transient Union Return Chaining

# Iterating

## \`yield

Yielding wraps the value in the transient union `Next`

Return `Void` to stop iteration

```text
fn : Fn[x] $ ( @ 1 .. x { `yield 2 * x } )
it : fn `sync 10
// invoking
@ it { `log v }[v] // 2 4 6 8 10 12 14 16 18 20
// same as above
@ {
    # `sync it {
        .value { `log v }[v]
        .done { `break }
        .error { `return e }[e]
    }
}
```

# Calling

## \`async

```text
task : `async fn
value : `wait task
```

## \`sync

```text
fn `sync args // `wait fn `async args
```