mirror of
https://github.com/fluencelabs/wasm-bindgen
synced 2025-04-30 08:02:23 +00:00
325 lines
30 KiB
HTML
325 lines
30 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="sidebar-visible no-js">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Deployment - The `wasm-bindgen` Guide</title>
|
||
|
|
|
||
|
|
|
||
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||
|
|
<meta name="description" content="">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta name="theme-color" content="#ffffff" />
|
||
|
|
|
||
|
|
<link rel="shortcut icon" href="../favicon.png">
|
||
|
|
<link rel="stylesheet" href="../css/variables.css">
|
||
|
|
<link rel="stylesheet" href="../css/general.css">
|
||
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
||
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
||
|
|
|
||
|
|
<!-- Fonts -->
|
||
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
||
|
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800" rel="stylesheet" type="text/css">
|
||
|
|
<link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500" rel="stylesheet" type="text/css">
|
||
|
|
|
||
|
|
<!-- Highlight.js Stylesheets -->
|
||
|
|
<link rel="stylesheet" href="../highlight.css">
|
||
|
|
<link rel="stylesheet" href="../tomorrow-night.css">
|
||
|
|
<link rel="stylesheet" href="../ayu-highlight.css">
|
||
|
|
|
||
|
|
<!-- Custom theme stylesheets -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</head>
|
||
|
|
<body class="light">
|
||
|
|
<!-- Provide site root to javascript -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var path_to_root = "../";
|
||
|
|
var default_theme = "light";
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
try {
|
||
|
|
var theme = localStorage.getItem('mdbook-theme');
|
||
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
|
|
||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
|
|
}
|
||
|
|
|
||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
|
|
}
|
||
|
|
} catch (e) { }
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var theme;
|
||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
|
|
document.body.className = theme;
|
||
|
|
document.querySelector('html').className = theme + ' js';
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
var sidebar = 'hidden';
|
||
|
|
if (document.body.clientWidth >= 1080) {
|
||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
|
|
sidebar = sidebar || 'visible';
|
||
|
|
}
|
||
|
|
html.classList.remove('sidebar-visible');
|
||
|
|
html.classList.add("sidebar-" + sidebar);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
|
|
<div class="sidebar-scrollbox">
|
||
|
|
<ol class="chapter"><li class="affix"><a href="../introduction.html">Introduction</a></li><li class="spacer"></li><li><a href="../examples/index.html"><strong aria-hidden="true">1.</strong> Examples</a></li><li><ol class="section"><li><a href="../examples/hello-world.html"><strong aria-hidden="true">1.1.</strong> Hello, World!</a></li><li><a href="../examples/console-log.html"><strong aria-hidden="true">1.2.</strong> Using console.log</a></li><li><a href="../examples/add.html"><strong aria-hidden="true">1.3.</strong> Small wasm files</a></li><li><a href="../examples/without-a-bundler.html"><strong aria-hidden="true">1.4.</strong> Without a Bundler</a></li><li><a href="../examples/wasm2js.html"><strong aria-hidden="true">1.5.</strong> Converting WebAssembly to JS</a></li><li><a href="../examples/import-js.html"><strong aria-hidden="true">1.6.</strong> Importing functions from JS</a></li><li><a href="../examples/char.html"><strong aria-hidden="true">1.7.</strong> Working with char</a></li><li><a href="../examples/wasm-in-wasm.html"><strong aria-hidden="true">1.8.</strong> js-sys: WebAssembly in WebAssembly</a></li><li><a href="../examples/dom.html"><strong aria-hidden="true">1.9.</strong> web-sys: DOM hello world</a></li><li><a href="../examples/closures.html"><strong aria-hidden="true">1.10.</strong> web-sys: Closures</a></li><li><a href="../examples/performance.html"><strong aria-hidden="true">1.11.</strong> web-sys: performance.now</a></li><li><a href="../examples/fetch.html"><strong aria-hidden="true">1.12.</strong> web-sys: using fetch</a></li><li><a href="../examples/2d-canvas.html"><strong aria-hidden="true">1.13.</strong> web-sys: canvas hello world</a></li><li><a href="../examples/julia.html"><strong aria-hidden="true">1.14.</strong> web-sys: canvas Julia set</a></li><li><a href="../examples/web-audio.html"><strong aria-hidden="true">1.15.</strong> web-sys: WebAudio</a></li><li><a href="../examples/webgl.html"><strong aria-hidden="true">1.16.</strong> web-sys: WebGL</a></li><li><a href="../examples/websockets.html"><strong aria-hidden="true">1.17.</strong> web-sys: WebSockets</a></li><li><a href="../examples/webrtc_datachannel.html"><strong aria-hidden="true">1.18.</strong> web-sys: WebRTC DataChannel</a></li><li><a href="../examples/request-animation-frame.html"><strong aria-hidden="true">1.19.</strong> web-sys: requestAnimationFrame</a></li><li><a href="../examples/paint.html"><strong aria-hidden="true">1.20.</strong> web-sys: A Simple Paint Program</a></li><li><a href="../examples/raytrace.html"><strong aria-hidden="true">1.21.</strong> Parallel Raytracing</a></li><li><a href="../examples/todomvc.html"><strong aria-hidden="true">1.22.</strong> web-sys: A TODO MVC App</a></li></ol></li><li><a href="../reference/index.html"><strong aria-hidden="true">2.</strong> Reference</a></li><li><ol class="section"><li><a href="../reference/deployment.html" class="active"><strong aria-hidden="true">2.1.</strong> Deployment</a></li><li><a href="../reference/js-snippets.html"><strong aria-hidden="true">2.2.</strong> JS snippets</a></li><li><a href="../reference/passing-rust-closures-to-js.html"><strong aria-hidden="true">2.3.</strong> Passing Rust Closures to JS</a></li><li><a href="../reference/receiving-js-closures-in-rust.html"><strong aria-hidden="true">2.4.</strong> Receiving JS Closures in Rust</a></li><li><a href="../reference/js-promises-and-rust-futures.html"><strong aria-hidden="true">2.5.</strong> Promises and Futures</a></li><li><a href="../reference/iterating-over-js-values.html"><strong aria-hidden="true">2.6.</strong> Iterating over JS Values</a></li><li><a href="../reference/arbitrary-data-with-serde.html"><strong aria-hidden="true">2.7.</strong> Arbitrary Data with Serde</a></li><li><a href="../reference/accessing-properties-of-untyped-js-values.html"><strong aria-hidden="true">2.8.</strong> Accessing Properties of Untyped JS Values</a></li><li><a href="../reference/working-with-duck-typed-interfaces.html"><strong aria-hidden="true">2.9.</strong> Working with Duck-Typed Interfaces</a></li><li>
|
||
|
|
</div>
|
||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
<style>
|
||
|
|
header.warning {
|
||
|
|
background-color: rgb(242, 222, 222);
|
||
|
|
border-bottom-color: rgb(238, 211, 215);
|
||
|
|
border-bottom-left-radius: 4px;
|
||
|
|
border-bottom-right-radius: 4px;
|
||
|
|
border-bottom-style: solid;
|
||
|
|
border-bottom-width: 0.666667px;
|
||
|
|
border-image-outset: 0 0 0 0;
|
||
|
|
border-image-repeat: stretch stretch;
|
||
|
|
border-image-slice: 100% 100% 100% 100%;
|
||
|
|
border-image-source: none;
|
||
|
|
border-image-width: 1 1 1 1;
|
||
|
|
border-left-color: rgb(238, 211, 215);
|
||
|
|
border-left-style: solid;
|
||
|
|
border-left-width: 0.666667px;
|
||
|
|
border-right-color: rgb(238, 211, 215);
|
||
|
|
border-right-style: solid;
|
||
|
|
border-right-width: 0.666667px;
|
||
|
|
border-top-color: rgb(238, 211, 215);
|
||
|
|
border-top-left-radius: 4px;
|
||
|
|
border-top-right-radius: 4px;
|
||
|
|
border-top-style: solid;
|
||
|
|
border-top-width: 0.666667px;
|
||
|
|
color: rgb(185, 74, 72);
|
||
|
|
margin-bottom: 0px;
|
||
|
|
margin-left: 0px;
|
||
|
|
margin-right: 0px;
|
||
|
|
margin-top: 30px;
|
||
|
|
padding-bottom: 8px;
|
||
|
|
padding-left: 14px;
|
||
|
|
padding-right: 35px;
|
||
|
|
padding-top: 8px;
|
||
|
|
text-align: center;
|
||
|
|
}
|
||
|
|
</style>
|
||
|
|
<header class='warning'>
|
||
|
|
This is the <strong>unpublished</strong> documentation of
|
||
|
|
<code>wasm-bindgen</code>, the published documentation is available
|
||
|
|
<a href="https://rustwasm.github.io/docs/wasm-bindgen/">
|
||
|
|
on the main Rust and WebAssembly documentation site
|
||
|
|
</a>. Features documented here may not be available in released versions of
|
||
|
|
<code>wasm-bindgen</code>.
|
||
|
|
</header>
|
||
|
|
|
||
|
|
<div id="menu-bar" class="menu-bar">
|
||
|
|
<div id="menu-bar-sticky-container">
|
||
|
|
<div class="left-buttons">
|
||
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
|
|
<i class="fa fa-bars"></i>
|
||
|
|
</button>
|
||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
|
|
<i class="fa fa-paint-brush"></i>
|
||
|
|
</button>
|
||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
||
|
|
<i class="fa fa-search"></i>
|
||
|
|
</button>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 class="menu-title">The `wasm-bindgen` Guide</h1>
|
||
|
|
|
||
|
|
<div class="right-buttons">
|
||
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
||
|
|
<i id="print-button" class="fa fa-print"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="search-wrapper" class="hidden">
|
||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
||
|
|
<input type="search" name="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
|
|
</form>
|
||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
||
|
|
<ul id="searchresults">
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<main>
|
||
|
|
<h1><a class="header" href="#deploying-rust-and-webassembly" id="deploying-rust-and-webassembly">Deploying Rust and WebAssembly</a></h1>
|
||
|
|
<p>At this point in time deploying Rust and WebAssembly to the web or other
|
||
|
|
locations unfortunately isn't a trivial task to do. This page hopes to serve
|
||
|
|
as documentation for the various known options, and as always PRs are welcome
|
||
|
|
to update this if it's out of date!</p>
|
||
|
|
<p>The methods of deployment and integration here are primarily tied to the
|
||
|
|
<code>--target</code> flag. Note that the <code>--target</code> flag of <code>wasm-pack</code> and <code>wasm-bindgen</code>
|
||
|
|
should behave the same way in this respect. The values possible here are:</p>
|
||
|
|
<table><thead><tr><th>Value</th><th>Summary</th></tr></thead><tbody>
|
||
|
|
<tr><td><a href="#bundlers"><code>bundler</code></a></td><td>Suitable for loading in bundlers like Webpack</td></tr>
|
||
|
|
<tr><td><a href="#without-a-bundler"><code>web</code></a></td><td>Directly loadable in a web browser</td></tr>
|
||
|
|
<tr><td><a href="#nodejs"><code>nodejs</code></a></td><td>Loadable via <code>require</code> as a Node.js module</td></tr>
|
||
|
|
<tr><td><a href="#Deno"><code>deno</code></a></td><td>Loadable using imports from Deno modules</td></tr>
|
||
|
|
<tr><td><a href="#without-a-bundler"><code>no-modules</code></a></td><td>Like <code>web</code>, but older and doesn't use ES modules</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<h2><a class="header" href="#bundlers" id="bundlers">Bundlers</a></h2>
|
||
|
|
<p><strong><code>--target bundler</code></strong></p>
|
||
|
|
<p>The default output of <code>wasm-bindgen</code>, or the <code>bundler</code> target, assumes a model
|
||
|
|
where the wasm module itself is natively an ES module. This model, however, is not
|
||
|
|
natively implemented in any JS implementation at this time. As a result, to
|
||
|
|
consume the default output of <code>wasm-bindgen</code> you will need a bundler of some
|
||
|
|
form.</p>
|
||
|
|
<blockquote>
|
||
|
|
<p><strong>Note</strong>: the choice of this default output was done to reflect the trends of
|
||
|
|
the JS ecosystem. While tools other than bundlers don't support wasm files as
|
||
|
|
native ES modules today they're all very much likely to in the future!</p>
|
||
|
|
</blockquote>
|
||
|
|
<p>Currently the only known bundler known to be fully compatible with
|
||
|
|
<code>wasm-bindgen</code> is <a href="https://webpack.js.org/">webpack</a>. Most <a href="../examples/index.html">examples</a> use webpack, and you can check out
|
||
|
|
the <a href="../examples/hello-world.html">hello world example online</a> to see the details of webpack configuration
|
||
|
|
necessary.</p>
|
||
|
|
<h2><a class="header" href="#without-a-bundler" id="without-a-bundler">Without a Bundler</a></h2>
|
||
|
|
<p><strong><code>--target web</code> or <code>--target no-modules</code></strong></p>
|
||
|
|
<p>If you're not using a bundler but you're still running code in a web browser,
|
||
|
|
<code>wasm-bindgen</code> still supports this! For this use case you'll want to use the
|
||
|
|
<code>--target web</code> flag. You can check out a <a href="../examples/without-a-bundler.html">full example</a> in the
|
||
|
|
documentation, but the highlights of this output are:</p>
|
||
|
|
<ul>
|
||
|
|
<li>When compiling you'll pass <code>--target web</code> to <code>wasm-pack</code> (or <code>wasm-bindgen</code>
|
||
|
|
directly).</li>
|
||
|
|
<li>The output can natively be included on a web page, and doesn't require any
|
||
|
|
further postprocessing. The output is included as an ES module.</li>
|
||
|
|
<li>The <code>--target web</code> mode is not able to use NPM dependencies.</li>
|
||
|
|
<li>You'll want to review the <a href="browser-support.html">browser requirements</a> for <code>wasm-bindgen</code> because
|
||
|
|
no polyfills will be available.</li>
|
||
|
|
</ul>
|
||
|
|
<p>The CLI also supports an output mode called <code>--target no-modules</code> which is
|
||
|
|
similar to the <code>web</code> target in that it requires manual initialization of the
|
||
|
|
wasm and is intended to be included in web pages without any further
|
||
|
|
postprocessing. See the <a href="../examples/without-a-bundler.html">without a bundler example</a> for some more
|
||
|
|
information about <code>--target no-modules</code>.</p>
|
||
|
|
<h2><a class="header" href="#nodejs" id="nodejs">Node.js</a></h2>
|
||
|
|
<p><strong><code>--target nodejs</code></strong></p>
|
||
|
|
<p>If you're deploying WebAssembly into Node.js (perhaps as an alternative to a
|
||
|
|
native module), then you'll want to pass the <code>--target nodejs</code> flag to
|
||
|
|
<code>wasm-pack</code> or <code>wasm-bindgen</code>.</p>
|
||
|
|
<p>Like the "without a bundler" strategy, this method of deployment does not
|
||
|
|
require any further postprocessing. The generated JS shims can be <code>require</code>'d
|
||
|
|
just like any other Node module (even the <code>*_bg</code> wasm file can be <code>require</code>'d
|
||
|
|
as it has a JS shim generated as well).</p>
|
||
|
|
<p>Note that this method requires a version of Node.js with WebAssembly support,
|
||
|
|
which is currently Node 8 and above.</p>
|
||
|
|
<h2><a class="header" href="#deno" id="deno">Deno</a></h2>
|
||
|
|
<p><strong><code>--target deno</code></strong></p>
|
||
|
|
<p>To deploy WebAssembly to Deno, use the <code>--target deno</code> flag.
|
||
|
|
To then import your module inside deno, use</p>
|
||
|
|
<pre><code class="language-ts">// @deno-types="./out/crate_name.d.ts"
|
||
|
|
import { yourFunction } from "./out/crate_name.js";
|
||
|
|
</code></pre>
|
||
|
|
<h2><a class="header" href="#npm" id="npm">NPM</a></h2>
|
||
|
|
<p>If you'd like to deploy compiled WebAssembly to NPM, then the tool for the job
|
||
|
|
is <a href="https://rustwasm.github.io/docs/wasm-pack/"><code>wasm-pack</code></a>. More information on this coming soon!</p>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
|
||
|
|
<a rel="prev" href="../reference/index.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<a rel="next" href="../reference/js-snippets.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
<div style="clear: both"></div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
|
|
|
||
|
|
<a href="../reference/index.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<a href="../reference/js-snippets.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
|
||
|
|
|
||
|
|
<script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../book.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
|
||
|
|
<!-- Custom JS scripts -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|