Files
google-apis-rs/futures_task/index.html
2021-04-02 00:20:57 +08:00

29 lines
8.5 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `futures_task` crate."><meta name="keywords" content="rust, rustlang, rust-lang, futures_task"><title>futures_task - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><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">&#9776;</div><a href='../futures_task/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate futures_task</p><div class="block version"><p>Version 0.3.13</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all futures_task's items</p></a><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="futures_task" data-ty="mod" data-relpath="../"></div></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></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><button type="button" class="help-button">?</button>
<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="in-band">Crate <a class="mod" href="">futures_task</a></span><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">&#x2212;</span>]</a></span><a class="srclink" href="../src/futures_task/lib.rs.html#1-54" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Tools for working with tasks.</p>
</div><h2 id="reexports" class="section-header"><a href="#reexports">Re-exports</a></h2>
<table><tr><td><code>pub use core::task::<a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a>;</code></td></tr><tr><td><code>pub use core::task::<a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a>;</code></td></tr><tr><td><code>pub use core::task::<a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker">Waker</a>;</code></td></tr><tr><td><code>pub use core::task::<a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.RawWaker.html" title="struct core::task::wake::RawWaker">RawWaker</a>;</code></td></tr><tr><td><code>pub use core::task::<a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.RawWakerVTable.html" title="struct core::task::wake::RawWakerVTable">RawWakerVTable</a>;</code></td></tr></table><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.FutureObj.html" title="futures_task::FutureObj struct">FutureObj</a></td><td class="docblock-short"><p>A custom trait object for polling futures, roughly akin to
<code>Box&lt;dyn Future&lt;Output = T&gt; + Send + 'a&gt;</code>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LocalFutureObj.html" title="futures_task::LocalFutureObj struct">LocalFutureObj</a></td><td class="docblock-short"><p>A custom trait object for polling futures, roughly akin to
<code>Box&lt;dyn Future&lt;Output = T&gt; + 'a&gt;</code>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SpawnError.html" title="futures_task::SpawnError struct">SpawnError</a></td><td class="docblock-short"><p>An error that occurred during spawning.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WakerRef.html" title="futures_task::WakerRef struct">WakerRef</a></td><td class="docblock-short"><p>A <a href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Waker.html" title="Waker"><code>Waker</code></a> that is only valid for a given lifetime.</p>
</td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
<table><tr class="module-item"><td><a class="trait" href="trait.ArcWake.html" title="futures_task::ArcWake trait">ArcWake</a></td><td class="docblock-short"><p>A way of waking up a specific task.</p>
</td></tr><tr class="module-item"><td><a class="trait" href="trait.LocalSpawn.html" title="futures_task::LocalSpawn trait">LocalSpawn</a></td><td class="docblock-short"><p>The <code>LocalSpawn</code> is similar to <a href="../futures_task/trait.Spawn.html" title="Spawn"><code>Spawn</code></a>, but allows spawning futures
that don't implement <code>Send</code>.</p>
</td></tr><tr class="module-item"><td><a class="trait" href="trait.Spawn.html" title="futures_task::Spawn trait">Spawn</a></td><td class="docblock-short"><p>The <code>Spawn</code> trait allows for pushing futures onto an executor that will
run them to completion.</p>
</td></tr><tr class="module-item"><td><a class="trait" href="trait.UnsafeFutureObj.html" title="futures_task::UnsafeFutureObj trait">UnsafeFutureObj</a></td><td class="docblock-short"><p>A custom implementation of a future trait object for <code>FutureObj</code>, providing
a vtable with drop support.</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.noop_waker.html" title="futures_task::noop_waker fn">noop_waker</a></td><td class="docblock-short"><p>Create a new <a href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Waker.html" title="Waker"><code>Waker</code></a> which does
nothing when <code>wake()</code> is called on it.</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.noop_waker_ref.html" title="futures_task::noop_waker_ref fn">noop_waker_ref</a></td><td class="docblock-short"><p>Get a static reference to a <a href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Waker.html" title="Waker"><code>Waker</code></a> which
does nothing when <code>wake()</code> is called on it.</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.waker.html" title="futures_task::waker fn">waker</a></td><td class="docblock-short"><p>Creates a <a href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Waker.html" title="Waker"><code>Waker</code></a> from an <code>Arc&lt;impl ArcWake&gt;</code>.</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.waker_ref.html" title="futures_task::waker_ref fn">waker_ref</a></td><td class="docblock-short"><p>Creates a reference to a <a href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Waker.html" title="Waker"><code>Waker</code></a> from a reference to <code>Arc&lt;impl ArcWake&gt;</code>.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="futures_task"></div>
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>