Current section
Files
Jump to
Current section
Files
doc/AshGleam.GleamBridge.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_gleam v0.4.0">
<title>AshGleam.GleamBridge — ash_gleam v0.4.0</title>
<link rel="stylesheet" href="dist/html-elixir-YJO4MOOW.css" />
<script defer src="dist/sidebar_items-37036786.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_gleam
</a>
<div class="sidebar-projectVersion" translate="no">
v0.4.0
</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-module" id="main" data-type="modules">
<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_gleam</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>
<span translate="no">AshGleam.<wbr>GleamBridge</span>
<small class="app-vsn" translate="no">(ash_gleam v0.4.0)</small>
</h1>
<a href="AshGleam.GleamBridge.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>
<section id="moduledoc">
<p>Standalone DSL for bidirectional Elixir↔Gleam function bridging.</p><p>Exposes Elixir functions to Gleam (<code class="inline">expose</code>) and makes Gleam functions
callable from Elixir (<code class="inline">consume</code>).</p><pre><code class="makeup elixir" translate="no"><span class="kd">defmodule</span><span class="w"> </span><span class="nc">MyApp.Math</span><span class="w"> </span><span class="k" data-group-id="7638077175-1">do</span><span class="w">
</span><span class="kn">use</span><span class="w"> </span><span class="nc">AshGleam.GleamBridge</span><span class="w">
</span><span class="n">gleam</span><span class="w"> </span><span class="k" data-group-id="7638077175-2">do</span><span class="w">
</span><span class="n">consume</span><span class="w"> </span><span class="k" data-group-id="7638077175-3">do</span><span class="w">
</span><span class="n">function</span><span class="w"> </span><span class="ss">:add_in_gleam</span><span class="p">,</span><span class="w"> </span><span class="ss">:integer</span><span class="w"> </span><span class="k" data-group-id="7638077175-4">do</span><span class="w">
</span><span class="n">argument</span><span class="w"> </span><span class="ss">:a</span><span class="p">,</span><span class="w"> </span><span class="ss">:integer</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="w">
</span><span class="n">argument</span><span class="w"> </span><span class="ss">:b</span><span class="p">,</span><span class="w"> </span><span class="ss">:integer</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="w">
</span><span class="n">run</span><span class="w"> </span><span class="o">&</span><span class="nc">:gleam_module</span><span class="o">.</span><span class="n">add</span><span class="o">/</span><span class="mi">2</span><span class="w">
</span><span class="k" data-group-id="7638077175-4">end</span><span class="w">
</span><span class="k" data-group-id="7638077175-3">end</span><span class="w">
</span><span class="n">expose</span><span class="w"> </span><span class="k" data-group-id="7638077175-5">do</span><span class="w">
</span><span class="n">function</span><span class="w"> </span><span class="ss">:add_in_elixir</span><span class="p">,</span><span class="w"> </span><span class="ss">:integer</span><span class="w"> </span><span class="k" data-group-id="7638077175-6">do</span><span class="w">
</span><span class="n">argument</span><span class="w"> </span><span class="ss">:a</span><span class="p">,</span><span class="w"> </span><span class="ss">:integer</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="w">
</span><span class="n">argument</span><span class="w"> </span><span class="ss">:b</span><span class="p">,</span><span class="w"> </span><span class="ss">:integer</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="w">
</span><span class="n">run</span><span class="w"> </span><span class="k" data-group-id="7638077175-7">fn</span><span class="w"> </span><span class="n">a</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="p" data-group-id="7638077175-8">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">b</span><span class="p" data-group-id="7638077175-8">}</span><span class="w"> </span><span class="k" data-group-id="7638077175-7">end</span><span class="w">
</span><span class="k" data-group-id="7638077175-6">end</span><span class="w">
</span><span class="k" data-group-id="7638077175-5">end</span><span class="w">
</span><span class="k" data-group-id="7638077175-2">end</span><span class="w">
</span><span class="k" data-group-id="7638077175-1">end</span></code></pre><h3 id="module-options" class="section-heading"><a href="#module-options" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Options</span></h3><ul><li><p><code class="inline">:extensions</code> (list of module that adopts <a href="https://hexdocs.pm/spark/2.6.1/Spark.Dsl.Extension.html"><code class="inline">Spark.Dsl.Extension</code></a>) - A list of DSL extensions to add to the <a href="https://hexdocs.pm/spark/2.6.1/Spark.Dsl.html"><code class="inline">Spark.Dsl</code></a></p></li><li><p><code class="inline">:otp_app</code> (<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types"><code class="inline">atom/0</code></a>) - The otp_app to use for any application configurable options</p></li><li><p><code class="inline">:fragments</code> (list of <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types"><code class="inline">module/0</code></a>) - Fragments to include in the <a href="https://hexdocs.pm/spark/2.6.1/Spark.Dsl.html"><code class="inline">Spark.Dsl</code></a>. See the fragments guide for more.</p></li></ul>
</section>
</div>
<footer class="footer">
<p>
<span class="line">
<a href="https://hex.pm/packages/ash_gleam/0.4.0">Hex Package</a>
<a href="https://preview.hex.pm/preview/ash_gleam/0.4.0">Hex Preview</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_gleam.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>