mirror of
https://github.com/fluencelabs/wasm-bindgen
synced 2025-06-12 04:21:21 +00:00
37 lines
7.5 KiB
HTML
37 lines
7.5 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `WebAssembly` mod in crate `js_sys`."><meta name="keywords" content="rust, rustlang, rust-lang, WebAssembly"><title>js_sys::WebAssembly - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../js_sys/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module WebAssembly</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>js_sys</a></p><script>window.sidebarCurrent = {name: 'WebAssembly', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/js_sys/lib.rs.html#3321-3592' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>js_sys</a>::<wbr><a class="mod" href=''>WebAssembly</a></span></h1><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.CompileError.html" title='js_sys::WebAssembly::CompileError struct'>CompileError</a></td><td class='docblock-short'><p>The <code>WebAssembly.CompileError()</code> constructor creates a new
|
||
WebAssembly <code>CompileError</code> object, which indicates an error during
|
||
WebAssembly decoding or validation.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Instance.html" title='js_sys::WebAssembly::Instance struct'>Instance</a></td><td class='docblock-short'><p>A <code>WebAssembly.Instance</code> object is a stateful, executable instance
|
||
of a <code>WebAssembly.Module</code>. Instance objects contain all the exported
|
||
WebAssembly functions that allow calling into WebAssembly code from
|
||
JavaScript.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.LinkError.html" title='js_sys::WebAssembly::LinkError struct'>LinkError</a></td><td class='docblock-short'><p>The <code>WebAssembly.LinkError()</code> constructor creates a new WebAssembly
|
||
LinkError object, which indicates an error during module
|
||
instantiation (besides traps from the start function).</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Memory.html" title='js_sys::WebAssembly::Memory struct'>Memory</a></td><td class='docblock-short'><p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Memory">MDN documentation</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Module.html" title='js_sys::WebAssembly::Module struct'>Module</a></td><td class='docblock-short'><p>A <code>WebAssembly.Module</code> object contains stateless WebAssembly code
|
||
that has already been compiled by the browser and can be
|
||
efficiently shared with Workers, and instantiated multiple times.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.RuntimeError.html" title='js_sys::WebAssembly::RuntimeError struct'>RuntimeError</a></td><td class='docblock-short'><p>The <code>WebAssembly.RuntimeError()</code> constructor creates a new WebAssembly
|
||
<code>RuntimeError</code> object — the type that is thrown whenever WebAssembly
|
||
specifies a trap.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Table.html" title='js_sys::WebAssembly::Table struct'>Table</a></td><td class='docblock-short'><p>The <code>WebAssembly.Table()</code> constructor creates a new <code>Table</code> object
|
||
of the given size and element type.</p>
|
||
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table><tr class='module-item'><td><a class="fn" href="fn.compile.html" title='js_sys::WebAssembly::compile fn'>compile</a></td><td class='docblock-short'><p>The <code>WebAssembly.compile()</code> function compiles a <code>WebAssembly.Module</code>
|
||
from WebAssembly binary code. This function is useful if it is
|
||
necessary to a compile a module before it can be instantiated
|
||
(otherwise, the <code>WebAssembly.instantiate()</code> function should be used).</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.instantiate_buffer.html" title='js_sys::WebAssembly::instantiate_buffer fn'>instantiate_buffer</a></td><td class='docblock-short'><p>The <code>WebAssembly.instantiate()</code> function allows you to compile and
|
||
instantiate WebAssembly code.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.instantiate_module.html" title='js_sys::WebAssembly::instantiate_module fn'>instantiate_module</a></td><td class='docblock-short'><p>The <code>WebAssembly.instantiate()</code> function allows you to compile and
|
||
instantiate WebAssembly code.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.instantiate_streaming.html" title='js_sys::WebAssembly::instantiate_streaming fn'>instantiate_streaming</a></td><td class='docblock-short'><p>The <code>WebAssembly.instantiateStreaming()</code> function compiles and
|
||
instantiates a WebAssembly module directly from a streamed
|
||
underlying source. This is the most efficient, optimized way to load
|
||
wasm code.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.validate.html" title='js_sys::WebAssembly::validate fn'>validate</a></td><td class='docblock-short'><p>The <code>WebAssembly.validate()</code> function validates a given typed
|
||
array of WebAssembly binary code, returning whether the bytes
|
||
form a valid wasm module (<code>true</code>) or not (<code>false</code>).</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "js_sys";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |