mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-31 14:24:01 +01:00
50 lines
10 KiB
HTML
50 lines
10 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 `task` mod in crate `futures`."><meta name="keywords" content="rust, rustlang, rust-lang, 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">☰</div><a href='../../futures/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module task</p><div class="sidebar-elems"><div class="block items"><ul><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></div><p class="location"><a href="../index.html">futures</a></p><div id="sidebar-vars" data-name="task" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></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">Module <a href="../index.html">futures</a>::<wbr><a class="mod" href="">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">−</span>]</a></span><a class="srclink" href="../../src/futures_util/lib.rs.html#325" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Tools for working with tasks.</p>
|
||
<p>This module contains:</p>
|
||
<ul>
|
||
<li><a href="../../futures/task/trait.Spawn.html" title="Spawn"><code>Spawn</code></a>, a trait for spawning new tasks.</li>
|
||
<li><a href="../../futures/task/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="../../futures/task/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><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.AtomicWaker.html" title="futures::task::AtomicWaker struct">AtomicWaker</a></td><td class="docblock-short"><p>A synchronization primitive for task wakeup.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Context.html" title="futures::task::Context struct">Context</a></td><td class="docblock-short"><p>The <code>Context</code> of an asynchronous task.</p>
|
||
</td></tr><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<dyn Future<Output = T> + Send + 'a></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<dyn Future<Output = T> + 'a></code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RawWaker.html" title="futures::task::RawWaker struct">RawWaker</a></td><td class="docblock-short"><p>A <code>RawWaker</code> allows the implementor of a task executor to create a <a href="../../futures/task/struct.Waker.html" title="Waker"><code>Waker</code></a>
|
||
which provides customized wakeup behavior.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RawWakerVTable.html" title="futures::task::RawWakerVTable struct">RawWakerVTable</a></td><td class="docblock-short"><p>A virtual function pointer table (vtable) that specifies the behavior
|
||
of a <a href="../../futures/task/struct.RawWaker.html" title="RawWaker"><code>RawWaker</code></a>.</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.Waker.html" title="futures::task::Waker struct">Waker</a></td><td class="docblock-short"><p>A <code>Waker</code> is a handle for waking up a task by notifying its executor that it
|
||
is ready to be run.</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="../../futures/task/struct.Waker.html" title="Waker"><code>Waker</code></a> that is only valid for a given lifetime.</p>
|
||
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
||
<table><tr class="module-item"><td><a class="enum" href="enum.Poll.html" title="futures::task::Poll enum">Poll</a></td><td class="docblock-short"><p>Indicates whether a value is available or if the current task has been
|
||
scheduled to receive a wakeup instead.</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.LocalSpawnExt.html" title="futures::task::LocalSpawnExt trait">LocalSpawnExt</a></td><td class="docblock-short"><p>Extension trait for <code>LocalSpawn</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.SpawnExt.html" title="futures::task::SpawnExt trait">SpawnExt</a></td><td class="docblock-short"><p>Extension trait for <code>Spawn</code>.</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="../../futures/task/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="../../futures/task/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="../../futures/task/struct.Waker.html" title="Waker"><code>Waker</code></a> from an <code>Arc<impl ArcWake></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="../../futures/task/struct.Waker.html" title="Waker"><code>Waker</code></a> from a reference to <code>Arc<impl ArcWake></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"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |