<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/src/rust_wasm_bindgen.md - fork/rules_rust @ main</title>
<meta name="description" content="docs/src/rust_wasm_bindgen.md in fork/rules_rust at main.">
<meta property="og:title" content="docs/src/rust_wasm_bindgen.md - fork/rules_rust @ main">
<meta property="og:description" content="docs/src/rust_wasm_bindgen.md in fork/rules_rust at main.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="main" data-tip="c07cb1b5e1bec3184239c28bdddd6c5a0a97d634">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rules_rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rules_rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">UebelAndre</span><span class="commit-message" data-commit="a7aba2d0317af14eccd7244ec72855ad21f35719">Added bzlmod support to all extension rules. (#3037)</span><span class="snapshot-sha sha" data-commit="a7aba2d0317af14eccd7244ec72855ad21f35719">a7aba2d0</span><time datetime="2024-12-04T14:09:00-08:00" title="2024-12-04 14:09:00 -0800">2024-12-04</time></p>
<header class="topbar"><details class="switcher"><summary>main</summary><div class="menu"><strong>branches</strong><a href="/fork/rules_rust/ref/cleanup/">cleanup</a><a href="/fork/rules_rust/ref/gh-pages/">gh-pages</a><a class="current" href="/fork/rules_rust/ref/main/">main</a><a href="/fork/rules_rust/ref/patching/">patching</a><a href="/fork/rules_rust/ref/rust-analyzer/">rust-analyzer</a><strong>tags</strong><a href="/fork/rules_rust/ref/0.10.0/">0.10.0</a><a href="/fork/rules_rust/ref/0.11.0/">0.11.0</a><a href="/fork/rules_rust/ref/0.5.0/">0.5.0</a><a href="/fork/rules_rust/ref/0.6.0/">0.6.0</a><a href="/fork/rules_rust/ref/0.7.0/">0.7.0</a><a href="/fork/rules_rust/ref/0.8.0/">0.8.0</a><a href="/fork/rules_rust/ref/0.8.1/">0.8.1</a><a href="/fork/rules_rust/ref/0.9.0/">0.9.0</a><a class="all" href="/fork/rules_rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rules_rust/">rules_rust</a> / <a href="/fork/rules_rust/ref/main/tree/docs/">docs</a> / <a href="/fork/rules_rust/ref/main/tree/docs/src/">src</a> / <span class="cur">rust_wasm_bindgen.md</span></nav>
<span class="view-stats"><span>5.6 KiB</span><span>137 lines</span></span><span class="actions"><a class="raw" href="/fork/rules_rust/raw/0c0c29b265c1e87a6559edf7b7906f64911ecb7f/docs/src/rust_wasm_bindgen.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered">&lt;!-- Generated with Stardoc: http://skydoc.bazel.build --&gt;
<h1>rules_rust_wasm_bindgen</h1>
<p>Bazel rules for generating wasm modules for Javascript using <a href="https://github.com/rustwasm/wasm-bindgen">wasm-bindgen</a>.</p>
<h2>Rules</h2>
<ul>
<li><a href="#rust_wasm_bindgen">rust_wasm_bindgen</a></li>
<li><a href="#rust_wasm_bindgen_toolchain">rust_wasm_bindgen_toolchain</a></li>
</ul>
<h2>Setup</h2>
<p>To begin using the <code>wasm-bindgen</code> rules, users can load the necessary dependencies
in their workspace by adding the following to their <code>WORKSPACE.bazel</code> file.</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust_wasm_bindgen//:repositories.bzl&quot;</a-s>, <a-s>&quot;rust_wasm_bindgen_dependencies&quot;</a-s>, <a-s>&quot;rust_wasm_bindgen_register_toolchains&quot;</a-s>)

<a-f>rust_wasm_bindgen_dependencies</a-f>()

<a-f>rust_wasm_bindgen_register_toolchains</a-f>()</pre>
<p>This should enable users to start using the <a href="#rust_wasm_bindgen">rust_wasm_bindgen</a>
rule. However, it's common to want to control the version of <code>wasm-bindgen</code> in the
workspace instead of relying on the one provided by <code>rules_rust</code>. In this case, users
should avoid calling <code>rust_wasm_bindgen_register_toolchains</code> and instead use the
<a href="#rust_wasm_bindgen_toolchain">rust_wasm_bindgen_toolchain</a> rule to define their own
toolchains to register in the workspace.</p>
<h2>Interfacing with Javascript rules</h2>
<p>While it's recommended for users to mantain their own , in the
<code>@rules_rust_wasm_bindgen</code> package there exists interface sub-packages for various
Javascript Bazel rules. E.g. <code>aspect_rules_js</code>. The rules defined there are a more
convenient way to use <code>rust_wasm_bindgen</code> with the associated javascript rules due
to the inclusion of additional providers. Each directory contains a <code>defs.bzl</code> file
that defines the different variants of <code>rust_wasm_bindgen</code>. (e.g. <code>js_rust_wasm_bindgen</code>
for the <code>rules_js</code> submodule).</p>
<p>&lt;a id="rust_wasm_bindgen"&gt;&lt;/a&gt;</p>
<h2>rust_wasm_bindgen</h2>
&lt;pre&gt;
rust_wasm_bindgen(&lt;a href="#rust_wasm_bindgen-name"&gt;name&lt;/a&gt;, &lt;a href="#rust_wasm_bindgen-bindgen_flags"&gt;bindgen_flags&lt;/a&gt;, &lt;a href="#rust_wasm_bindgen-target"&gt;target&lt;/a&gt;, &lt;a href="#rust_wasm_bindgen-target_arch"&gt;target_arch&lt;/a&gt;, &lt;a href="#rust_wasm_bindgen-wasm_file"&gt;wasm_file&lt;/a&gt;)
&lt;/pre&gt;
<p>Generates javascript and typescript bindings for a webassembly module using <a href="https://rustwasm.github.io/docs/wasm-bindgen/">wasm-bindgen</a>.</p>
<p>An example of this rule in use can be seen at <a href="../examples/wasm">@rules_rust//examples/wasm</a></p>
<p><strong>ATTRIBUTES</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th><th style="text-align: left">Type</th><th style="text-align: left">Mandatory</th><th style="text-align: left">Default</th></tr></thead><tbody>
<tr><td style="text-align: left">&lt;a id="rust_wasm_bindgen-name"&gt;&lt;/a&gt;name</td><td style="text-align: left">A unique name for this target.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels#target-names"&gt;Name&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_wasm_bindgen-bindgen_flags"&gt;&lt;/a&gt;bindgen_flags</td><td style="text-align: left">Flags to pass directly to the bindgen executable. See https://github.com/rustwasm/wasm-bindgen/ for details.</td><td style="text-align: left">List of strings</td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_wasm_bindgen-target"&gt;&lt;/a&gt;target</td><td style="text-align: left">The type of output to generate. See https://rustwasm.github.io/wasm-bindgen/reference/deployment.html for details.</td><td style="text-align: left">String</td><td style="text-align: left">optional</td><td style="text-align: left"><code>"bundler"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_wasm_bindgen-target_arch"&gt;&lt;/a&gt;target_arch</td><td style="text-align: left">The target architecture to use for the wasm-bindgen command line option.</td><td style="text-align: left">String</td><td style="text-align: left">optional</td><td style="text-align: left"><code>"wasm32"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_wasm_bindgen-wasm_file"&gt;&lt;/a&gt;wasm_file</td><td style="text-align: left">The <code>.wasm</code> file or crate to generate bindings for.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
</tbody></table>
<p>&lt;a id="rust_wasm_bindgen_toolchain"&gt;&lt;/a&gt;</p>
<h2>rust_wasm_bindgen_toolchain</h2>
&lt;pre&gt;
rust_wasm_bindgen_toolchain(&lt;a href="#rust_wasm_bindgen_toolchain-name"&gt;name&lt;/a&gt;, &lt;a href="#rust_wasm_bindgen_toolchain-bindgen"&gt;bindgen&lt;/a&gt;)
&lt;/pre&gt;
<p>The tools required for the <code>rust_wasm_bindgen</code> rule.</p>
<p>In cases where users want to control or change the version of <code>wasm-bindgen</code> used by <a href="#rust_wasm_bindgen">rust_wasm_bindgen</a>,
a unique toolchain can be created as in the example below:</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust_bindgen//:defs.bzl&quot;</a-s>, <a-s>&quot;rust_bindgen_toolchain&quot;</a-s>)

<a-f>rust_bindgen_toolchain</a-f>(
    <a-v>bindgen</a-v> <a-o>=</a-o> <a-s>&quot;//3rdparty/crates:wasm_bindgen_cli__bin&quot;</a-s>,
)

<a-f>toolchain</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;wasm_bindgen_toolchain&quot;</a-s>,
    <a-v>toolchain</a-v> <a-o>=</a-o> <a-s>&quot;wasm_bindgen_toolchain_impl&quot;</a-s>,
    <a-v>toolchain_type</a-v> <a-o>=</a-o> <a-s>&quot;@rules_rust_wasm_bindgen//:toolchain_type&quot;</a-s>,
)</pre>
<p>Now that you have your own toolchain, you need to register it by
inserting the following statement in your <code>WORKSPACE</code> file:</p>
<pre class="language-python"><a-f>register_toolchains</a-f>(<a-s>&quot;//my/toolchains:wasm_bindgen_toolchain&quot;</a-s>)</pre>
<p>For additional information, see the <a href="https://docs.bazel.build/versions/master/toolchains.html">Bazel toolchains documentation</a>.</p>
<p><strong>ATTRIBUTES</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th><th style="text-align: left">Type</th><th style="text-align: left">Mandatory</th><th style="text-align: left">Default</th></tr></thead><tbody>
<tr><td style="text-align: left">&lt;a id="rust_wasm_bindgen_toolchain-name"&gt;&lt;/a&gt;name</td><td style="text-align: left">A unique name for this target.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels#target-names"&gt;Name&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_wasm_bindgen_toolchain-bindgen"&gt;&lt;/a&gt;bindgen</td><td style="text-align: left">The label of a <code>wasm-bindgen-cli</code> executable.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>None</code></td></tr>
</tbody></table>
<p>&lt;a id="RustWasmBindgenInfo"&gt;&lt;/a&gt;</p>
<h2>RustWasmBindgenInfo</h2>
&lt;pre&gt;
RustWasmBindgenInfo(&lt;a href="#RustWasmBindgenInfo-js"&gt;js&lt;/a&gt;, &lt;a href="#RustWasmBindgenInfo-ts"&gt;ts&lt;/a&gt;, &lt;a href="#RustWasmBindgenInfo-wasm"&gt;wasm&lt;/a&gt;)
&lt;/pre&gt;
<p>Info about wasm-bindgen outputs.</p>
<p><strong>FIELDS</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th></tr></thead><tbody>
<tr><td style="text-align: left">&lt;a id="RustWasmBindgenInfo-js"&gt;&lt;/a&gt;js</td><td style="text-align: left">Depset[File]: The Javascript files produced by <code>wasm-bindgen</code>.</td></tr>
<tr><td style="text-align: left">&lt;a id="RustWasmBindgenInfo-ts"&gt;&lt;/a&gt;ts</td><td style="text-align: left">Depset[File]: The Typescript files produced by <code>wasm-bindgen</code>.</td></tr>
<tr><td style="text-align: left">&lt;a id="RustWasmBindgenInfo-wasm"&gt;&lt;/a&gt;wasm</td><td style="text-align: left">File: The <code>.wasm</code> file generated by <code>wasm-bindgen</code>.</td></tr>
</tbody></table>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-c>&lt;!-- Generated with Stardoc: http://skydoc.bazel.build --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>#</a-p> <a-tt>rules_rust_wasm_bindgen</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">Bazel rules for generating wasm modules for Javascript using [wasm-bindgen][wb].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>##</a-p> <a-tt>Rules</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>- </a-p>[rust_wasm_bindgen](#rust_wasm_bindgen)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>- </a-p>[rust_wasm_bindgen_toolchain](#rust_wasm_bindgen_toolchain)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>## </a-p><a-tt>Setup</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>To begin using the `wasm-bindgen` rules, users can load the necessary dependencies</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>in their workspace by adding the following to their `WORKSPACE.bazel` file.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>```</a-p><a-tl>python</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust_wasm_bindgen//:repositories.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_wasm_bindgen_dependencies&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_wasm_bindgen_register_toolchains&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>rust_wasm_bindgen_dependencies()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>rust_wasm_bindgen_register_toolchains()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>This should enable users to start using the [rust_wasm_bindgen](#rust_wasm_bindgen)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>rule. However, it&#39;s common to want to control the version of `wasm-bindgen` in the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>workspace instead of relying on the one provided by `rules_rust`. In this case, users</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>should avoid calling `rust_wasm_bindgen_register_toolchains` and instead use the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>[rust_wasm_bindgen_toolchain](#rust_wasm_bindgen_toolchain) rule to define their own</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>toolchains to register in the workspace.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>## </a-p><a-tt>Interfacing with Javascript rules</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>While it&#39;s recommended for users to mantain their own , in the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>`@rules_rust_wasm_bindgen` package there exists interface sub-packages for various</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>Javascript Bazel rules. E.g. `aspect_rules_js`. The rules defined there are a more</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>convenient way to use `rust_wasm_bindgen` with the associated javascript rules due</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>to the inclusion of additional providers. Each directory contains a `defs.bzl` file</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>that defines the different variants of `rust_wasm_bindgen`. (e.g. `js_rust_wasm_bindgen`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>for the `rules_js` submodule).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-tu>[wb]</a-tu><a-p>: </a-p><a-tu>https://github.com/rustwasm/wasm-bindgen</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>&lt;a id=&quot;rust_wasm_bindgen&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>## </a-p><a-tt>rust_wasm_bindgen</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>&lt;</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>rust_wasm_bindgen(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_wasm_bindgen-name</a-s><a-p>&quot;&gt;name&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_wasm_bindgen-bindgen_flags</a-s><a-p>&quot;&gt;bindgen_flags&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_wasm_bindgen-target</a-s><a-p>&quot;&gt;target&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_wasm_bindgen-target_arch</a-s><a-p>&quot;&gt;target_arch&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_wasm_bindgen-wasm_file</a-s><a-p>&quot;&gt;wasm_file&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>Generates javascript and typescript bindings for a webassembly module using [wasm-bindgen][ws].</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-tu>[ws]</a-tu><a-p>: </a-p><a-tu>https://rustwasm.github.io/docs/wasm-bindgen/</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>An example of this rule in use can be seen at [@rules_rust//examples/wasm](../examples/wasm)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>**ATTRIBUTES**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>| Name  | Description | Type | Mandatory | Default |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_wasm_bindgen-name&quot;&gt;&lt;/a&gt;name |  A unique name for this target.   | &lt;a href=&quot;https://bazel.build/concepts/labels#target-names&quot;&gt;Name&lt;/a&gt; | required |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_wasm_bindgen-bindgen_flags&quot;&gt;&lt;/a&gt;bindgen_flags |  Flags to pass directly to the bindgen executable. See https://github.com/rustwasm/wasm-bindgen/ for details.   | List of strings | optional |  `[]`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_wasm_bindgen-target&quot;&gt;&lt;/a&gt;target |  The type of output to generate. See https://rustwasm.github.io/wasm-bindgen/reference/deployment.html for details.   | String | optional |  `&quot;bundler&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_wasm_bindgen-target_arch&quot;&gt;&lt;/a&gt;target_arch |  The target architecture to use for the wasm-bindgen command line option.   | String | optional |  `&quot;wasm32&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_wasm_bindgen-wasm_file&quot;&gt;&lt;/a&gt;wasm_file |  The `.wasm` file or crate to generate bindings for.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | required |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>&lt;a id=&quot;rust_wasm_bindgen_toolchain&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>## </a-p><a-tt>rust_wasm_bindgen_toolchain</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>&lt;</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>rust_wasm_bindgen_toolchain(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_wasm_bindgen_toolchain-name</a-s><a-p>&quot;&gt;name&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_wasm_bindgen_toolchain-bindgen</a-s><a-p>&quot;&gt;bindgen&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>The tools required for the `rust_wasm_bindgen` rule.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>In cases where users want to control or change the version of `wasm-bindgen` used by [rust_wasm_bindgen](#rust_wasm_bindgen),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>a unique toolchain can be created as in the example below:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>```</a-p><a-tl>python</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust_bindgen//:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_bindgen_toolchain&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>rust_bindgen_toolchain(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>    </a-p><a-v>bindgen</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;//3rdparty/crates:wasm_bindgen_cli__bin&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>toolchain(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;wasm_bindgen_toolchain&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>    </a-p><a-v>toolchain</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;wasm_bindgen_toolchain_impl&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>    </a-p><a-v>toolchain_type</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;@rules_rust_wasm_bindgen//:toolchain_type&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>Now that you have your own toolchain, you need to register it by</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>inserting the following statement in your `WORKSPACE` file:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>```</a-p><a-tl>python</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>register_toolchains(</a-p><a-s>&quot;//my/toolchains:wasm_bindgen_toolchain&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>For additional information, see the [Bazel toolchains documentation][toolchains].</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-tu>[toolchains]</a-tu><a-p>: </a-p><a-tu>https://docs.bazel.build/versions/master/toolchains.html</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>**ATTRIBUTES**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>| Name  | Description | Type | Mandatory | Default |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_wasm_bindgen_toolchain-name&quot;&gt;&lt;/a&gt;name |  A unique name for this target.   | &lt;a href=&quot;https://bazel.build/concepts/labels#target-names&quot;&gt;Name&lt;/a&gt; | required |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_wasm_bindgen_toolchain-bindgen&quot;&gt;&lt;/a&gt;bindgen |  The label of a `wasm-bindgen-cli` executable.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | optional |  `None`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>&lt;a id=&quot;RustWasmBindgenInfo&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>## </a-p><a-tt>RustWasmBindgenInfo</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"><a-p>&lt;</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p>RustWasmBindgenInfo(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#RustWasmBindgenInfo-js</a-s><a-p>&quot;&gt;js&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#RustWasmBindgenInfo-ts</a-s><a-p>&quot;&gt;ts&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#RustWasmBindgenInfo-wasm</a-s><a-p>&quot;&gt;wasm&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text">Info about wasm-bindgen outputs.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text">**FIELDS**</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text">| Name  | Description |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text">| :------------- | :------------- |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text">| &lt;a id=&quot;RustWasmBindgenInfo-js&quot;&gt;&lt;/a&gt;js |  Depset[File]: The Javascript files produced by `wasm-bindgen`.    |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text">| &lt;a id=&quot;RustWasmBindgenInfo-ts&quot;&gt;&lt;/a&gt;ts |  Depset[File]: The Typescript files produced by `wasm-bindgen`.    |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text">| &lt;a id=&quot;RustWasmBindgenInfo-wasm&quot;&gt;&lt;/a&gt;wasm |  File: The `.wasm` file generated by `wasm-bindgen`.    |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
