rtic/stable/api/futures_task/index.html
github-merge-queue[bot] e04fb16c1b deploy: bbc37ca3fe
2025-11-12 19:06:49 +00:00

9 lines
No EOL
6.7 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="Tools for working with tasks."><title>futures_task - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="futures_task" data-themes="" data-resource-suffix="" data-rustdoc-version="1.91.1 (ed61e7d7e 2025-11-07)" data-channel="1.91.1" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-6dc2a7f3.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Crate futures_task</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../futures_task/index.html">futures_<wbr>task</a><span class="version">0.3.31</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>futures_<wbr>task</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/futures_task/lib.rs.html#1-50">Source</a> </span></div><details class="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="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.Context"><code>pub use core::task::<a class="struct" href="https://doc.rust-lang.org/1.91.1/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a>;</code></dt><dt id="reexport.Poll"><code>pub use core::task::<a class="enum" href="https://doc.rust-lang.org/1.91.1/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a>;</code></dt><dt id="reexport.RawWaker"><code>pub use core::task::<a class="struct" href="https://doc.rust-lang.org/1.91.1/core/task/wake/struct.RawWaker.html" title="struct core::task::wake::RawWaker">RawWaker</a>;</code></dt><dt id="reexport.RawWakerVTable"><code>pub use core::task::<a class="struct" href="https://doc.rust-lang.org/1.91.1/core/task/wake/struct.RawWakerVTable.html" title="struct core::task::wake::RawWakerVTable">RawWakerVTable</a>;</code></dt><dt id="reexport.Waker"><code>pub use core::task::<a class="struct" href="https://doc.rust-lang.org/1.91.1/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker">Waker</a>;</code></dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.FutureObj.html" title="struct futures_task::FutureObj">Future<wbr>Obj</a></dt><dd>A custom trait object for polling futures, roughly akin to
<code>Box&lt;dyn Future&lt;Output = T&gt; + Send + 'a&gt;</code>.</dd><dt><a class="struct" href="struct.LocalFutureObj.html" title="struct futures_task::LocalFutureObj">Local<wbr>Future<wbr>Obj</a></dt><dd>A custom trait object for polling futures, roughly akin to
<code>Box&lt;dyn Future&lt;Output = T&gt; + 'a&gt;</code>.</dd><dt><a class="struct" href="struct.SpawnError.html" title="struct futures_task::SpawnError">Spawn<wbr>Error</a></dt><dd>An error that occurred during spawning.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.LocalSpawn.html" title="trait futures_task::LocalSpawn">Local<wbr>Spawn</a></dt><dd>The <code>LocalSpawn</code> is similar to <a href="trait.Spawn.html" title="trait futures_task::Spawn"><code>Spawn</code></a>, but allows spawning futures
that dont implement <code>Send</code>.</dd><dt><a class="trait" href="trait.Spawn.html" title="trait futures_task::Spawn">Spawn</a></dt><dd>The <code>Spawn</code> trait allows for pushing futures onto an executor that will
run them to completion.</dd><dt><a class="trait" href="trait.UnsafeFutureObj.html" title="trait futures_task::UnsafeFutureObj">Unsafe<wbr>Future<wbr>Obj</a></dt><dd>A custom implementation of a future trait object for <code>FutureObj</code>, providing
a vtable with drop support.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.noop_waker.html" title="fn futures_task::noop_waker">noop_<wbr>waker</a></dt><dd>Create a new <a href="https://doc.rust-lang.org/1.91.1/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>Waker</code></a> which does
nothing when <code>wake()</code> is called on it.</dd><dt><a class="fn" href="fn.noop_waker_ref.html" title="fn futures_task::noop_waker_ref">noop_<wbr>waker_<wbr>ref</a></dt><dd>Get a static reference to a <a href="https://doc.rust-lang.org/1.91.1/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>Waker</code></a> which
does nothing when <code>wake()</code> is called on it.</dd></dl></section></div></main></body></html>