mirror of
https://github.com/fluencelabs/wasm-bindgen
synced 2025-05-23 18:51:21 +00:00
36 lines
5.6 KiB
HTML
36 lines
5.6 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 `wasm_bindgen_futures` crate."><meta name="keywords" content="rust, rustlang, rust-lang, wasm_bindgen_futures"><title>wasm_bindgen_futures - 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='../wasm_bindgen_futures/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate wasm_bindgen_futures</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all wasm_bindgen_futures's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'wasm_bindgen_futures', ty: 'mod', relpath: '../'};</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/wasm_bindgen_futures/lib.rs.html#1-227' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>wasm_bindgen_futures</a></span></h1><div class='docblock'><p>Converting between JavaScript <code>Promise</code>s to Rust <code>Future</code>s.</p>
|
||
<p>This crate provides a bridge for working with JavaScript <code>Promise</code> types as
|
||
a Rust <code>Future</code>, and similarly contains utilities to turn a rust <code>Future</code>
|
||
into a JavaScript <code>Promise</code>. This can be useful when working with
|
||
asynchronous or otherwise blocking work in Rust (wasm), and provides the
|
||
ability to interoperate with JavaScript events and JavaScript I/O
|
||
primitives.</p>
|
||
<p>There are three main interfaces in this crate currently:</p>
|
||
<ol>
|
||
<li>
|
||
<p><a href="./struct.JsFuture.html"><strong><code>JsFuture</code></strong></a></p>
|
||
<p>A type that is constructed with a <code>Promise</code> and can then be used as a
|
||
<code>Future<Output = Result<JsValue, JsValue>></code>. This Rust future will resolve
|
||
or reject with the value coming out of the <code>Promise</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><a href="./fn.future_to_promise.html"><strong><code>future_to_promise</code></strong></a></p>
|
||
<p>Converts a Rust <code>Future<Output = Result<JsValue, JsValue>></code> into a
|
||
JavaScript <code>Promise</code>. The future's result will translate to either a
|
||
resolved or rejected <code>Promise</code> in JavaScript.</p>
|
||
</li>
|
||
<li>
|
||
<p><a href="./fn.spawn_local.html"><strong><code>spawn_local</code></strong></a></p>
|
||
<p>Spawns a <code>Future<Output = ()></code> on the current thread. This is the
|
||
best way to run a <code>Future</code> in Rust without sending it to JavaScript.</p>
|
||
</li>
|
||
</ol>
|
||
<p>These three items should provide enough of a bridge to interoperate the two
|
||
systems and make sure that Rust/JavaScript can work together with
|
||
asynchronous and I/O work.</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.JsFuture.html" title='wasm_bindgen_futures::JsFuture struct'>JsFuture</a></td><td class='docblock-short'><p>A Rust <code>Future</code> backed by a JavaScript <code>Promise</code>.</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.future_to_promise.html" title='wasm_bindgen_futures::future_to_promise fn'>future_to_promise</a></td><td class='docblock-short'><p>Converts a Rust <code>Future</code> into a JavaScript <code>Promise</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.spawn_local.html" title='wasm_bindgen_futures::spawn_local fn'>spawn_local</a></td><td class='docblock-short'><p>Runs a Rust <code>Future</code> on the current thread.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "wasm_bindgen_futures";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |