blob: 74dff2e9f0bd3a43893d09a36cef738357420ecb [file] [log] [blame]
<!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="Tools for working with tasks."><meta name="keywords" content="rust, rustlang, rust-lang, futures_task"><title>futures_task - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../futures_task/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../futures_task/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate futures_task</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.3.28</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><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></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">futures_task</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/futures_task/lib.rs.html#1-50">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Tools for working with tasks.</p>
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><div class="item-table"><div class="item-row"><div class="item-left import-item" id="reexport.Context"><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></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Poll"><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></div></div><div class="item-row"><div class="item-left import-item" id="reexport.RawWaker"><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></div></div><div class="item-row"><div class="item-left import-item" id="reexport.RawWakerVTable"><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></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Waker"><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></div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FutureObj.html" title="futures_task::FutureObj struct">FutureObj</a></div><div class="item-right docblock-short">A custom trait object for polling futures, roughly akin to
<code>Box&lt;dyn Future&lt;Output = T&gt; + Send + 'a&gt;</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.LocalFutureObj.html" title="futures_task::LocalFutureObj struct">LocalFutureObj</a></div><div class="item-right docblock-short">A custom trait object for polling futures, roughly akin to
<code>Box&lt;dyn Future&lt;Output = T&gt; + 'a&gt;</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SpawnError.html" title="futures_task::SpawnError struct">SpawnError</a></div><div class="item-right docblock-short">An error that occurred during spawning.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.WakerRef.html" title="futures_task::WakerRef struct">WakerRef</a></div><div class="item-right docblock-short">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.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ArcWake.html" title="futures_task::ArcWake trait">ArcWake</a></div><div class="item-right docblock-short">A way of waking up a specific task.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.LocalSpawn.html" title="futures_task::LocalSpawn trait">LocalSpawn</a></div><div class="item-right docblock-short">The <code>LocalSpawn</code> is similar to <a href="trait.Spawn.html" title="Spawn"><code>Spawn</code></a>, but allows spawning futures
that don’t implement <code>Send</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Spawn.html" title="futures_task::Spawn trait">Spawn</a></div><div class="item-right docblock-short">The <code>Spawn</code> trait allows for pushing futures onto an executor that will
run them to completion.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.UnsafeFutureObj.html" title="futures_task::UnsafeFutureObj trait">UnsafeFutureObj</a></div><div class="item-right docblock-short">A custom implementation of a future trait object for <code>FutureObj</code>, providing
a vtable with drop support.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.noop_waker.html" title="futures_task::noop_waker fn">noop_waker</a></div><div class="item-right docblock-short">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.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.noop_waker_ref.html" title="futures_task::noop_waker_ref fn">noop_waker_ref</a></div><div class="item-right docblock-short">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.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.waker.html" title="futures_task::waker fn">waker</a></div><div class="item-right docblock-short">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>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.waker_ref.html" title="futures_task::waker_ref fn">waker_ref</a></div><div class="item-right docblock-short">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>.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="futures_task" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>