# Fn

---

```text
Fn_class `alias Enum[
    .unknown; .incomplete; .native
    .task; process; .generator; .iterator; .closure;
    .bound;
    .regex
]

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

# Function Classes

## Unknown

Placeholder before evaluation

## Incomplete

A function with an incomplete type, type checking occurs at invocation

## Native

Native function wrapper

## Task

A queue-able function in a process or iterator

## Process

A list of tasks with state

## Generator

A function for creating an iterator or closure

## Iterator

A task creator with state, cannot take arguments, can be called until done

## Closure

A task creator with state that can take arguments

## Bound

A function with some arguments already set

## Regex

Regular Expression

# Returning

## \`return

## Transient Union Return Chaining

# Iterating

## \`yield

Yielding wraps the value in the transient union `Next`

Return `Void` to stop iteration

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

# Calling

## \`async

Asynchronous call

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

## \`sync

Synchronous call

If the callee is a process, an inline wait with async is used

```text
fn `sync args // can be turned into `wait fn `async args
```