ludic/docs/language/builtins/fn-some.md
Orkuncakilkaya 790eda6f73
All checks were successful
bootstrap / cfree-fixpoint (push) Successful in 20s
ci / build-and-test (push) Successful in 1m31s
commit-lint / conventional-commits (push) Successful in 6s
docs / build-and-deploy (push) Successful in 23s
feat(types): option (some/none) safety type (#53)
Types phase 3 — the option/result safety pair. result/ok/err/try shipped in
#46; this adds its companion option:

- some(v)   -> option   (present value; any i32-width scalar)
- none()    -> option   (empty; no magic -1 sentinel)
- is_some / is_none -> bool
- unwrap_or(o, fallback) -> int

A heap %Option = { i32 present, i32 value }, bare builtins guarded by find_fn
(a user fn of the same name still wins), gated by g_uses_option so unused
programs compile byte-identically — same idiom as result.

Wired: emit_call codegen + %Option decl (emit_decl) + g_uses_option (emit_core),
reseeded seed, vocabulary sync (header/JetBrains/TextMate), builtin docs +
inventory, and a self-asserting example (examples/library/optionresult.ludic +
feat_case). All suites green incl. golden renders byte-identical and the
bootstrap fixpoint.

Tagged-union enums (variant payloads + binding match + exhaustiveness) are the
deep type-system feature, split out to #56.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-08-31 19:11:27 +03:00

1 KiB

id name category kind tokens sig tip order
fn-some some builtins builtin some some(v) -> option Wrap a present value in an option. 16

Wraps a present value in an option — the value type that models maybe a value without a magic -1 sentinel. An option is either some(value) (this) or none (empty); test it with is_some / is_none and read it with unwrap_or. The payload is any i32-width scalar — int, fixed, bool, or entity.

Parameters:

  • v — the present value
program Targeting {
  function nearest(count: int) -> option {
    if count == 0 { return none() }
    return some(count - 1)          # the nearest target index
  }
  test "some carries the value" {
    let t = unwrap_or(nearest(3), 0 - 1)
    expect_eq(t, 2)
  }
}