ludic/fn-unwrap_or.html
2026-09-17 22:10:03 +00:00

32 lines
No EOL
2.1 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>unwrap_or — Ludic</title>
<meta name="description" content="The option value, or a fallback if empty.">
<link rel="stylesheet" href="base.css">
<link rel="stylesheet" href="docs.css">
</head>
<body>
<header class="nav"><div class="wrap nav-in"><a class="brand" href="index.html"><span class="logo">L</span> Ludic</a><button class="nav-toggle" aria-label="Toggle menu" aria-expanded="false">☰</button><nav class="nav-links"><a href="index.html">Home</a><a href="api.html">API Reference</a><a class="nav-cta" href="https://git.workshopsoft.io/workshopsoft/ludic">Source ↗</a></nav></div></header>
<main class="wrap item">
<div class="crumbs"><a href="api.html">API Reference</a> <span>›</span> <a href="api.html#builtins">Builtin functions</a> <span>›</span> <span class="here">unwrap_or</span></div>
<div class="item-head">
<span class="kind-badge kind-builtin">function</span>
<h1 id="top">unwrap_or</h1>
</div>
<code class="sig">unwrap_or(o: option, fallback) -&gt; int</code>
<div class="desc"><p>Reads an <code>option</code>: returns its value when it is <a href="fn-some"><code>some</code></a>, or <code>fallback</code> when it is <a href="fn-none"><code>none</code></a>. The safe, one-line way to get a usable value out of an option without a separate branch.</p></div>
<div class="params"><h2>Parameters</h2><div class="param" id="param-o"><code class="pname">o</code><span class="pdesc">the option to read</span></div><div class="param" id="param-fallback"><code class="pname">fallback</code><span class="pdesc">the value to use when the option is empty</span></div></div>
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program Config {
handler Step phase Update {
let volume = unwrap_or(none(), 100) # default to 100
}
}</pre></div>
<a class="back" href="api.html">← All symbols</a>
</main>
<script src="ludic-highlight.js"></script>
<script>Ludic.highlightAll(); Ludic.installCards(); Ludic.flashTarget();</script>
</body></html>