Current section
Files
Jump to
Current section
Files
doc/readme.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.40.1">
<meta name="project" content="ash_sum_type v1.0.3">
<title>AshSumType — ash_sum_type v1.0.3</title>
<link rel="stylesheet" href="dist/html-elixir-YJO4MOOW.css" />
<script defer src="dist/sidebar_items-59C0813D.js"></script>
<script defer src="docs_config.js"></script>
<script defer src="dist/html-YU4BZFVS.js"></script>
</head>
<body>
<script>(()=>{var t="ex_doc:settings",e="dark";var o="dark",s="light";var E="sidebar_state",n="closed";var r="sidebar_width";var a="sidebar-open";var i=new URLSearchParams(window.location.search),S=i.get("theme")||JSON.parse(localStorage.getItem(t)||"{}").theme;(S===o||S!==s&&window.matchMedia("(prefers-color-scheme: dark)").matches)&&document.body.classList.add(e);var d=sessionStorage.getItem(E),A=d!==n&&!window.matchMedia(`screen and (max-width: ${768}px)`).matches;document.body.classList.toggle(a,A);var c=sessionStorage.getItem(r);c&&document.body.style.setProperty("--sidebarWidth",`${c}px`);var p=/(Macintosh|iPhone|iPad|iPod)/.test(window.navigator.userAgent);document.documentElement.classList.toggle("apple-os",p);})();
</script>
<div class="body-wrapper">
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<nav id="sidebar" class="sidebar">
<div class="sidebar-header">
<div class="sidebar-projectInfo">
<div>
<a href="api-reference.html" class="sidebar-projectName" translate="no">
ash_sum_type
</a>
<div class="sidebar-projectVersion" translate="no">
v1.0.3
</div>
</div>
</div>
<ul id="sidebar-list-nav" class="sidebar-list-nav" role="tablist" data-extras="Pages"></ul>
</div>
</nav>
<output role="status" id="toast"></output>
<main class="content page-extra" id="main" data-type="extras">
<div id="content" class="content-inner">
<div class="top-search">
<div class="search-settings">
<form class="search-bar" action="search.html">
<label class="search-label">
<span class="sr-only">Search documentation of ash_sum_type</span>
<div class="search-input-wrapper">
<input name="q" type="text" class="search-input" placeholder="Press / to search" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
<i class="ri-close-line ri-lg" title="Cancel search"></i>
</button>
</div>
</label>
</form>
<div class="autocomplete">
</div>
<div class="engine-selector" data-multiple="false">
<button type="button" class="engine-button" aria-label="Select search engine" aria-haspopup="true" aria-expanded="false">
<i class="ri-search-2-line" aria-hidden="true"></i>
<span class="engine-name">Default</span>
<i class="ri-arrow-down-s-line" aria-hidden="true"></i>
</button>
<div class="engine-dropdown" hidden role="menu">
<button type="button"
class="engine-option"
data-engine-url="search.html?q="
role="menuitemradio"
aria-checked="true">
<span class="name">Default</span>
<span class="help">In-browser search</span>
</button>
</div>
</div>
<button class="icon-settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
</div>
</div>
<div id="top-content">
<div class="heading-with-actions top-heading">
<h1>AshSumType</h1>
<a href="readme.md" title="Copy Markdown (hold Ctrl/Cmd and click it to open as Markdown)" class="copy-markdown icon-action" rel="help">
<i class="ri-markdown-line" aria-hidden="true"></i>
<span class="sr-only">Copy Markdown</span>
</a>
</div>
<p><a href="AshSumType.html"><code class="inline">AshSumType</code></a> is a Spark DSL for defining custom Ash types that behave like algebraic sum types.</p><p>It lets you declare tagged variants with optional carried fields, work with them in Elixir as atoms or tuples, and persist them through Ash as maps.</p><h2 id="defining-a-sum-type" class="section-heading"><a href="#defining-a-sum-type" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Defining A Sum Type</span></h2><pre><code class="makeup elixir" translate="no"><span class="kd">defmodule</span><span class="w"> </span><span class="nc">MyApp.Result</span><span class="w"> </span><span class="k" data-group-id="2119900791-1">do</span><span class="w">
</span><span class="kn">use</span><span class="w"> </span><span class="nc">AshSumType</span><span class="w">
</span><span class="n">variant</span><span class="w"> </span><span class="ss">:loading</span><span class="w">
</span><span class="n">variant</span><span class="w"> </span><span class="ss">:ok</span><span class="w"> </span><span class="k" data-group-id="2119900791-2">do</span><span class="w">
</span><span class="n">field</span><span class="w"> </span><span class="ss">:value</span><span class="p">,</span><span class="w"> </span><span class="ss">:integer</span><span class="w">
</span><span class="k" data-group-id="2119900791-2">end</span><span class="w">
</span><span class="n">variant</span><span class="w"> </span><span class="ss">:error</span><span class="w"> </span><span class="k" data-group-id="2119900791-3">do</span><span class="w">
</span><span class="n">field</span><span class="w"> </span><span class="ss">:message</span><span class="p">,</span><span class="w"> </span><span class="ss">:string</span><span class="w">
</span><span class="k" data-group-id="2119900791-3">end</span><span class="w">
</span><span class="k" data-group-id="2119900791-1">end</span></code></pre><p>This defines an Ash type with two variants:</p><ul><li><code class="inline">:loading</code>, which is a bare atom <code class="inline">:loading</code></li><li><code class="inline">:ok</code>, which carries an integer eg <code class="inline">{:ok, 1}</code></li><li><code class="inline">:error</code>, which carries a string message <code class="inline">{:error, "Not found"}</code></li></ul><section role="note" class="admonition tip"><h4 class="admonition-title tip">Tip</h4><p>Fields are not nilable by default</p></section><p>For enum-like variants, you can also use a shorthand:</p><pre><code class="makeup elixir" translate="no"><span class="kd">defmodule</span><span class="w"> </span><span class="nc">MyApp.Player</span><span class="w"> </span><span class="k" data-group-id="8949609206-1">do</span><span class="w">
</span><span class="kn">use</span><span class="w"> </span><span class="nc">AshSumType</span><span class="p">,</span><span class="w"> </span><span class="ss">variants</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="8949609206-2">[</span><span class="ss">:x</span><span class="p">,</span><span class="w"> </span><span class="ss">:o</span><span class="p" data-group-id="8949609206-2">]</span><span class="w">
</span><span class="k" data-group-id="8949609206-1">end</span></code></pre><h2 id="constructing-values" class="section-heading"><a href="#constructing-values" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Constructing Values</span></h2><p>You can construct values either from a variant name plus named fields, or from an existing atom/tuple representation.</p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex> </span><span class="nc">MyApp.Result</span><span class="o">.</span><span class="n">new</span><span class="p" data-group-id="0477551872-1">(</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="ss">value</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p" data-group-id="0477551872-1">)</span><span class="w">
</span><span class="p" data-group-id="0477551872-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0477551872-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p" data-group-id="0477551872-3">}</span><span class="p" data-group-id="0477551872-2">}</span><span class="w">
</span><span class="c1"># Or directly with a tuple</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">MyApp.Result</span><span class="o">.</span><span class="n">new</span><span class="p" data-group-id="0477551872-4">(</span><span class="p" data-group-id="0477551872-5">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="s">"not found"</span><span class="p" data-group-id="0477551872-5">}</span><span class="p" data-group-id="0477551872-4">)</span><span class="w">
</span><span class="p" data-group-id="0477551872-6">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0477551872-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="s">"not found"</span><span class="p" data-group-id="0477551872-7">}</span><span class="p" data-group-id="0477551872-6">}</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">MyApp.Result</span><span class="o">.</span><span class="n">new!</span><span class="p" data-group-id="0477551872-8">(</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="ss">value</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p" data-group-id="0477551872-8">)</span><span class="w">
</span><span class="p" data-group-id="0477551872-9">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p" data-group-id="0477551872-9">}</span><span class="w">
</span><span class="c1"># Or directly with a tuple</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">MyApp.Result</span><span class="o">.</span><span class="n">new!</span><span class="p" data-group-id="0477551872-10">(</span><span class="p" data-group-id="0477551872-11">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p" data-group-id="0477551872-11">}</span><span class="p" data-group-id="0477551872-10">)</span><span class="w">
</span><span class="p" data-group-id="0477551872-12">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p" data-group-id="0477551872-12">}</span><span class="w">
</span><span class="c1"># For atom variants</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">MyApp.Result</span><span class="o">.</span><span class="n">new!</span><span class="p" data-group-id="0477551872-13">(</span><span class="ss">:loading</span><span class="p" data-group-id="0477551872-13">)</span><span class="w">
</span><span class="ss">:loading</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">MyApp.Player</span><span class="o">.</span><span class="n">new</span><span class="p" data-group-id="0477551872-14">(</span><span class="ss">:x</span><span class="p" data-group-id="0477551872-14">)</span><span class="w">
</span><span class="p" data-group-id="0477551872-15">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="ss">:x</span><span class="p" data-group-id="0477551872-15">}</span></code></pre><h2 id="nesting" class="section-heading"><a href="#nesting" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Nesting</span></h2><p>A field can itself be another <a href="AshSumType.html"><code class="inline">AshSumType</code></a> type:</p><pre><code class="makeup elixir" translate="no"><span class="kd">defmodule</span><span class="w"> </span><span class="nc">MyApp.GameWinner</span><span class="w"> </span><span class="k" data-group-id="9857108240-1">do</span><span class="w">
</span><span class="kn">use</span><span class="w"> </span><span class="nc">AshSumType</span><span class="w">
</span><span class="n">variant</span><span class="w"> </span><span class="ss">:player</span><span class="w"> </span><span class="k" data-group-id="9857108240-2">do</span><span class="w">
</span><span class="n">field</span><span class="w"> </span><span class="ss">:player</span><span class="p">,</span><span class="w"> </span><span class="nc">MyApp.Player</span><span class="w">
</span><span class="k" data-group-id="9857108240-2">end</span><span class="w">
</span><span class="n">variant</span><span class="w"> </span><span class="ss">:draw</span><span class="w">
</span><span class="k" data-group-id="9857108240-1">end</span></code></pre><p>This allows values like:</p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex> </span><span class="nc">MyApp.GameWinner</span><span class="o">.</span><span class="n">new!</span><span class="p" data-group-id="8353393969-1">(</span><span class="ss">:draw</span><span class="p" data-group-id="8353393969-1">)</span><span class="w">
</span><span class="ss">:draw</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">MyApp.GameWinner</span><span class="o">.</span><span class="n">new!</span><span class="p" data-group-id="8353393969-2">(</span><span class="p" data-group-id="8353393969-3">{</span><span class="ss">:player</span><span class="p">,</span><span class="w"> </span><span class="ss">:x</span><span class="p" data-group-id="8353393969-3">}</span><span class="p" data-group-id="8353393969-2">)</span><span class="w">
</span><span class="p" data-group-id="8353393969-4">{</span><span class="ss">:player</span><span class="p">,</span><span class="w"> </span><span class="ss">:x</span><span class="p" data-group-id="8353393969-4">}</span></code></pre><h2 id="what-it-provides" class="section-heading"><a href="#what-it-provides" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">What It Provides</span></h2><ul><li>A compact DSL for declaring variants</li><li>Validation of fields through regular Ash types</li><li>In-memory values represented as atoms or tuples</li><li>Database/native values represented as maps with a reserved <code class="inline">__variant__</code> key</li><li>Support for nesting one sum type inside another</li><li>Use as a normal Ash attribute type</li></ul><h2 id="installation" class="section-heading"><a href="#installation" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Installation</span></h2><p>Add the dependency to <code class="inline">mix.exs</code>:</p><pre><code class="makeup elixir" translate="no"><span class="kd">def</span><span class="w"> </span><span class="nf">deps</span><span class="w"> </span><span class="k" data-group-id="3131675500-1">do</span><span class="w">
</span><span class="p" data-group-id="3131675500-2">[</span><span class="w">
</span><span class="p" data-group-id="3131675500-3">{</span><span class="ss">:ash_sum_type</span><span class="p">,</span><span class="w"> </span><span class="s">"~> 1.0.0"</span><span class="p" data-group-id="3131675500-3">}</span><span class="w">
</span><span class="p" data-group-id="3131675500-2">]</span><span class="w">
</span><span class="k" data-group-id="3131675500-1">end</span></code></pre><h2 id="persistence-format" class="section-heading"><a href="#persistence-format" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Persistence Format</span></h2><p>In memory, values are represented as:</p><ul><li><code class="inline">:variant</code> for variants with no fields</li><li><code class="inline">{:variant, field1, field2, ...}</code> for variants with carried fields</li></ul><p>When dumped to Ash/native storage, they become maps:</p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex> </span><span class="nc">MyApp.Result</span><span class="o">.</span><span class="n">dump_to_native</span><span class="p" data-group-id="4196577311-1">(</span><span class="p" data-group-id="4196577311-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p" data-group-id="4196577311-2">}</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4196577311-3">[</span><span class="p" data-group-id="4196577311-3">]</span><span class="p" data-group-id="4196577311-1">)</span><span class="w">
</span><span class="p" data-group-id="4196577311-4">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4196577311-5">%{</span><span class="ss">__variant__</span><span class="p">:</span><span class="w"> </span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="ss">value</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p" data-group-id="4196577311-5">}</span><span class="p" data-group-id="4196577311-4">}</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">MyApp.Player</span><span class="o">.</span><span class="n">dump_to_native</span><span class="p" data-group-id="4196577311-6">(</span><span class="ss">:x</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4196577311-7">[</span><span class="p" data-group-id="4196577311-7">]</span><span class="p" data-group-id="4196577311-6">)</span><span class="w">
</span><span class="p" data-group-id="4196577311-8">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4196577311-9">%{</span><span class="ss">__variant__</span><span class="p">:</span><span class="w"> </span><span class="ss">:x</span><span class="p" data-group-id="4196577311-9">}</span><span class="p" data-group-id="4196577311-8">}</span></code></pre><p>The <code class="inline">__variant__</code> key is reserved for the variant tag.</p><h2 id="using-it-in-ash-resources" class="section-heading"><a href="#using-it-in-ash-resources" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Using It In Ash Resources</span></h2><pre><code class="makeup elixir" translate="no"><span class="kd">defmodule</span><span class="w"> </span><span class="nc">MyApp.Game</span><span class="w"> </span><span class="k" data-group-id="3749730928-1">do</span><span class="w">
</span><span class="kn">use</span><span class="w"> </span><span class="nc">Ash.Resource</span><span class="p">,</span><span class="w">
</span><span class="ss">domain</span><span class="p">:</span><span class="w"> </span><span class="nc">MyApp.Games</span><span class="p">,</span><span class="w">
</span><span class="ss">data_layer</span><span class="p">:</span><span class="w"> </span><span class="nc">Ash.DataLayer.Ets</span><span class="w">
</span><span class="n">attributes</span><span class="w"> </span><span class="k" data-group-id="3749730928-2">do</span><span class="w">
</span><span class="n">uuid_primary_key</span><span class="w"> </span><span class="ss">:id</span><span class="w">
</span><span class="n">attribute</span><span class="w"> </span><span class="ss">:winner</span><span class="p">,</span><span class="w"> </span><span class="nc">MyApp.GameWinner</span><span class="p">,</span><span class="w"> </span><span class="ss">allow_nil?</span><span class="p">:</span><span class="w"> </span><span class="no">false</span><span class="p">,</span><span class="w"> </span><span class="ss">public?</span><span class="p">:</span><span class="w"> </span><span class="no">true</span><span class="w">
</span><span class="k" data-group-id="3749730928-2">end</span><span class="w">
</span><span class="n">actions</span><span class="w"> </span><span class="k" data-group-id="3749730928-3">do</span><span class="w">
</span><span class="n">defaults</span><span class="w"> </span><span class="p" data-group-id="3749730928-4">[</span><span class="ss">:read</span><span class="p" data-group-id="3749730928-4">]</span><span class="w">
</span><span class="n">create</span><span class="w"> </span><span class="ss">:create</span><span class="w"> </span><span class="k" data-group-id="3749730928-5">do</span><span class="w">
</span><span class="n">primary?</span><span class="w"> </span><span class="no">true</span><span class="w">
</span><span class="n">accept</span><span class="w"> </span><span class="p" data-group-id="3749730928-6">[</span><span class="ss">:winner</span><span class="p" data-group-id="3749730928-6">]</span><span class="w">
</span><span class="k" data-group-id="3749730928-5">end</span><span class="w">
</span><span class="k" data-group-id="3749730928-3">end</span><span class="w">
</span><span class="k" data-group-id="3749730928-1">end</span><span class="w">
</span><span class="kd">defmodule</span><span class="w"> </span><span class="nc">MyApp.Games</span><span class="w"> </span><span class="k" data-group-id="3749730928-7">do</span><span class="w">
</span><span class="kn">use</span><span class="w"> </span><span class="nc">Ash.Domain</span><span class="p">,</span><span class="w"> </span><span class="ss">validate_config_inclusion?</span><span class="p">:</span><span class="w"> </span><span class="no">false</span><span class="w">
</span><span class="n">resources</span><span class="w"> </span><span class="k" data-group-id="3749730928-8">do</span><span class="w">
</span><span class="n">resource</span><span class="w"> </span><span class="nc">MyApp.Game</span><span class="w"> </span><span class="k" data-group-id="3749730928-9">do</span><span class="w">
</span><span class="n">define</span><span class="w"> </span><span class="ss">:create_game</span><span class="p">,</span><span class="w"> </span><span class="ss">action</span><span class="p">:</span><span class="w"> </span><span class="ss">:create</span><span class="p">,</span><span class="w"> </span><span class="ss">args</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3749730928-10">[</span><span class="ss">:winner</span><span class="p" data-group-id="3749730928-10">]</span><span class="w">
</span><span class="k" data-group-id="3749730928-9">end</span><span class="w">
</span><span class="k" data-group-id="3749730928-8">end</span><span class="w">
</span><span class="k" data-group-id="3749730928-7">end</span></code></pre><p>Example usage:</p><pre><code class="makeup elixir" translate="no"><span class="nc">MyApp.Games</span><span class="o">.</span><span class="n">create_game!</span><span class="p" data-group-id="4910491629-1">(</span><span class="p" data-group-id="4910491629-2">{</span><span class="ss">:player</span><span class="p">,</span><span class="w"> </span><span class="ss">:x</span><span class="p" data-group-id="4910491629-2">}</span><span class="p" data-group-id="4910491629-1">)</span></code></pre><h2 id="validation-behavior" class="section-heading"><a href="#validation-behavior" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Validation Behavior</span></h2><p>Carried fields are validated with the Ash type you declare for each field. For example, this will fail because <code class="inline">:value</code> must be an integer:</p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex> </span><span class="nc">MyApp.Result</span><span class="o">.</span><span class="n">new</span><span class="p" data-group-id="7933010770-1">(</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="ss">value</span><span class="p">:</span><span class="w"> </span><span class="s">"nope"</span><span class="p" data-group-id="7933010770-1">)</span><span class="w">
</span><span class="p" data-group-id="7933010770-2">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="n">error</span><span class="p" data-group-id="7933010770-2">}</span></code></pre><p>Fields also reject <code class="inline">nil</code> by default. If you want to allow <code class="inline">nil</code>, opt in explicitly:</p><pre><code class="makeup elixir" translate="no"><span class="kd">defmodule</span><span class="w"> </span><span class="nc">MyApp.MaybeLabel</span><span class="w"> </span><span class="k" data-group-id="7865484149-1">do</span><span class="w">
</span><span class="kn">use</span><span class="w"> </span><span class="nc">AshSumType</span><span class="w">
</span><span class="n">variant</span><span class="w"> </span><span class="ss">:some</span><span class="w"> </span><span class="k" data-group-id="7865484149-2">do</span><span class="w">
</span><span class="n">field</span><span class="w"> </span><span class="ss">:value</span><span class="p">,</span><span class="w"> </span><span class="ss">:string</span><span class="p">,</span><span class="w"> </span><span class="ss">allow_nil?</span><span class="p">:</span><span class="w"> </span><span class="no">true</span><span class="w">
</span><span class="k" data-group-id="7865484149-2">end</span><span class="w">
</span><span class="n">variant</span><span class="w"> </span><span class="ss">:none</span><span class="w">
</span><span class="k" data-group-id="7865484149-1">end</span></code></pre><p>Unknown variants, unknown carried fields, invalid field values, and wrong tuple arity are rejected.</p><h2 id="api-summary" class="section-heading"><a href="#api-summary" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">API Summary</span></h2><ul><li><code class="inline">new/1</code> validates an existing atom or tuple representation</li><li><code class="inline">new/2</code> constructs a value from a variant name and named fields</li><li><code class="inline">new!/1</code> and <code class="inline">new!/2</code> are raising variants</li><li><code class="inline">variants/0</code> returns the declared variants</li><li><code class="inline">variant_names/0</code> returns declared variant names</li><li><code class="inline">fields/1</code> returns the fields for a variant</li></ul>
</div>
<div class="bottom-actions" id="bottom-actions">
<div class="bottom-actions-item">
</div>
<div class="bottom-actions-item">
</div>
</div>
<footer class="footer">
<p>
<span class="line">
<a href="https://hex.pm/packages/ash_sum_type/1.0.3">Hex Package</a>
<a href="https://preview.hex.pm/preview/ash_sum_type/1.0.3">Hex Preview</a>
(<a href="https://preview.hex.pm/preview/ash_sum_type/1.0.3/show/README.md">current file</a>)
</span>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Go to package docs">
Go to package docs
</button>
<a href="llms.txt" target="_blank">
View llms.txt
</a>
<a href="ash_sum_type.epub">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.40.1) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</main>
</div>
</body>
</html>