| <!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, 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="../../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"><!--[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">☰</button><a class="sidebar-logo" href="../../futures/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/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module task</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</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">Module <a href="../index.html">futures</a>::<wbr><a class="mod" href="#">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_util/lib.rs.html#309">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</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> |
| <p>This module contains:</p> |
| <ul> |
| <li><a href="trait.Spawn.html" title="Spawn"><code>Spawn</code></a>, a trait for spawning new tasks.</li> |
| <li><a href="struct.Context.html" title="Context"><code>Context</code></a>, a context of an asynchronous task, |
| including a handle for waking up the task.</li> |
| <li><a href="struct.Waker.html" title="Waker"><code>Waker</code></a>, a handle for waking up a task.</li> |
| </ul> |
| <p>The remaining types and traits in the module are used for implementing |
| executors or dealing with synchronization issues around task wakeup.</p> |
| </div></details><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.AtomicWaker.html" title="futures::task::AtomicWaker struct">AtomicWaker</a></div><div class="item-right docblock-short">A synchronization primitive for task wakeup.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Context.html" title="futures::task::Context struct">Context</a></div><div class="item-right docblock-short">The context of an asynchronous task.</div></div><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<dyn Future<Output = T> + Send + 'a></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<dyn Future<Output = T> + 'a></code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RawWaker.html" title="futures::task::RawWaker struct">RawWaker</a></div><div class="item-right docblock-short">A <code>RawWaker</code> allows the implementor of a task executor to create a <a href="struct.Waker.html" title="Waker"><code>Waker</code></a> |
| which provides customized wakeup behavior.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RawWakerVTable.html" title="futures::task::RawWakerVTable struct">RawWakerVTable</a></div><div class="item-right docblock-short">A virtual function pointer table (vtable) that specifies the behavior |
| of a <a href="struct.RawWaker.html" title="RawWaker"><code>RawWaker</code></a>.</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.Waker.html" title="futures::task::Waker struct">Waker</a></div><div class="item-right docblock-short">A <code>Waker</code> is a handle for waking up a task by notifying its executor that it |
| is ready to be run.</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="struct.Waker.html" title="Waker"><code>Waker</code></a> that is only valid for a given lifetime.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Poll.html" title="futures::task::Poll enum">Poll</a></div><div class="item-right docblock-short">Indicates whether a value is available or if the current task has been |
| scheduled to receive a wakeup instead.</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.LocalSpawnExt.html" title="futures::task::LocalSpawnExt trait">LocalSpawnExt</a></div><div class="item-right docblock-short">Extension trait for <code>LocalSpawn</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.SpawnExt.html" title="futures::task::SpawnExt trait">SpawnExt</a></div><div class="item-right docblock-short">Extension trait for <code>Spawn</code>.</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="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="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="struct.Waker.html" title="Waker"><code>Waker</code></a> from an <code>Arc<impl ArcWake></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="struct.Waker.html" title="Waker"><code>Waker</code></a> from a reference to <code>Arc<impl ArcWake></code>.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
