rtic/2/api/futures_task/index.html
github-merge-queue[bot] 5b32b958a3 deploy: f17915842f
2024-11-27 19:34:22 +00:00

9 lines
No EOL
7.3 KiB
HTML
Raw Permalink 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-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-492a78a4a87dcc01.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.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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" title="show sidebar"></button></nav><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><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><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">futures_task</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/futures_task/lib.rs.html#1-50">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></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><ul class="item-table"><li><div class="item-name" id="reexport.Context"><code>pub use core::task::<a class="struct" href="https://doc.rust-lang.org/1.82.0/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a>;</code></div></li><li><div class="item-name" id="reexport.Poll"><code>pub use core::task::<a class="enum" href="https://doc.rust-lang.org/1.82.0/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a>;</code></div></li><li><div class="item-name" id="reexport.RawWaker"><code>pub use core::task::<a class="struct" href="https://doc.rust-lang.org/1.82.0/core/task/wake/struct.RawWaker.html" title="struct core::task::wake::RawWaker">RawWaker</a>;</code></div></li><li><div class="item-name" id="reexport.RawWakerVTable"><code>pub use core::task::<a class="struct" href="https://doc.rust-lang.org/1.82.0/core/task/wake/struct.RawWakerVTable.html" title="struct core::task::wake::RawWakerVTable">RawWakerVTable</a>;</code></div></li><li><div class="item-name" id="reexport.Waker"><code>pub use core::task::<a class="struct" href="https://doc.rust-lang.org/1.82.0/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker">Waker</a>;</code></div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.FutureObj.html" title="struct futures_task::FutureObj">Future<wbr>Obj</a></div><div class="desc 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></li><li><div class="item-name"><a class="struct" href="struct.LocalFutureObj.html" title="struct futures_task::LocalFutureObj">Local<wbr>Future<wbr>Obj</a></div><div class="desc 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></li><li><div class="item-name"><a class="struct" href="struct.SpawnError.html" title="struct futures_task::SpawnError">Spawn<wbr>Error</a></div><div class="desc docblock-short">An error that occurred during spawning.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.LocalSpawn.html" title="trait futures_task::LocalSpawn">Local<wbr>Spawn</a></div><div class="desc docblock-short">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>.</div></li><li><div class="item-name"><a class="trait" href="trait.Spawn.html" title="trait futures_task::Spawn">Spawn</a></div><div class="desc docblock-short">The <code>Spawn</code> trait allows for pushing futures onto an executor that will
run them to completion.</div></li><li><div class="item-name"><a class="trait" href="trait.UnsafeFutureObj.html" title="trait futures_task::UnsafeFutureObj">Unsafe<wbr>Future<wbr>Obj</a></div><div class="desc docblock-short">A custom implementation of a future trait object for <code>FutureObj</code>, providing
a vtable with drop support.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.noop_waker.html" title="fn futures_task::noop_waker">noop_<wbr>waker</a></div><div class="desc docblock-short">Create a new <a href="https://doc.rust-lang.org/1.82.0/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.</div></li><li><div class="item-name"><a class="fn" href="fn.noop_waker_ref.html" title="fn futures_task::noop_waker_ref">noop_<wbr>waker_<wbr>ref</a></div><div class="desc docblock-short">Get a static reference to a <a href="https://doc.rust-lang.org/1.82.0/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.</div></li></ul></section></div></main></body></html>