Narra

Reference

std/option

std/option

Helpers over Option, the type of a value that may be missing.

narra
import * as Options from "std/option"

The guide teaches it in chapter 6, Option and Result.

This page is generated by scripts/std/generate.nra from narrac query --json interface std/option. Do not edit it.

Functions

map

narra
export function map<T, U, effect E>(option: Option<T>, f: (T) => U uses E): Option<U> uses alloc, E

Effects: alloc, E.

andThen

narra
export function andThen<T, U, effect E>(option: Option<T>, f: (T) => Option<U> uses E): Option<U> uses E

Effects: E.

withDefault

narra
export function withDefault<T>(option: Option<T>, fallback: T): T from option

Effects: none.

orElse

narra
export function orElse<T, effect E>(option: Option<T>, f: () => Option<T> uses E): Option<T> from option uses E

Effects: E.

isSome

narra
export function isSome<T>(option: Option<T>): bool

Effects: none.

isNone

narra
export function isNone<T>(option: Option<T>): bool

Effects: none.

okOr

narra
export function okOr<T, F>(option: Option<T>, error: F): Result<T, F> from option uses alloc

Effects: alloc.