32 lines
8.4 KiB
HTML
32 lines
8.4 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="A way of waking up a specific task."><title>ArcWake in 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-ca0dd0c4.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.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.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 trait"><!--[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="#">ArcWake</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.32</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">ArcWake</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.wake_by_ref" title="wake_by_ref">wake_by_ref</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.wake" title="wake">wake</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate futures_<wbr>task</a></h2></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"><div class="rustdoc-breadcrumbs"><a href="index.html">futures_task</a></div><h1>Trait <span class="trait">ArcWake</span> <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/arc_wake.rs.html#20-49">Source</a> </span></div><pre class="rust item-decl"><code>pub trait ArcWake: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
|
|
// Required method
|
|
fn <a href="#tymethod.wake_by_ref" class="fn">wake_by_ref</a>(arc_self: &<a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>);
|
|
|
|
// Provided method
|
|
fn <a href="#method.wake" class="fn">wake</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>) { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A way of waking up a specific task.</p>
|
|
<p>By implementing this trait, types that are expected to be wrapped in an <code>Arc</code>
|
|
can be converted into <a href="https://doc.rust-lang.org/1.93.1/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>Waker</code></a> objects.
|
|
Those Wakers can be used to signal executors that a task it owns
|
|
is ready to be <code>poll</code>ed again.</p>
|
|
<p>Currently, there are two ways to convert <code>ArcWake</code> into <a href="https://doc.rust-lang.org/1.93.1/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>Waker</code></a>:</p>
|
|
<ul>
|
|
<li><a href="fn.waker.html" title="fn futures_task::waker"><code>waker</code></a> converts <code>Arc<impl ArcWake></code> into <a href="https://doc.rust-lang.org/1.93.1/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>Waker</code></a>.</li>
|
|
<li><a href="fn.waker_ref.html" title="fn futures_task::waker_ref"><code>waker_ref</code></a> converts <code>&Arc<impl ArcWake></code> into <a href="struct.WakerRef.html" title="struct futures_task::WakerRef"><code>WakerRef</code></a> that
|
|
provides access to a <a href="https://doc.rust-lang.org/1.93.1/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>&Waker</code></a>.</li>
|
|
</ul>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.wake_by_ref" class="method"><a class="src rightside" href="../src/futures_task/arc_wake.rs.html#48">Source</a><h4 class="code-header">fn <a href="#tymethod.wake_by_ref" class="fn">wake_by_ref</a>(arc_self: &<a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>)</h4></section></summary><div class="docblock"><p>Indicates that the associated task is ready to make progress and should
|
|
be <code>poll</code>ed.</p>
|
|
<p>This function can be called from an arbitrary thread, including threads which
|
|
did not create the <code>ArcWake</code> based <a href="https://doc.rust-lang.org/1.93.1/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>Waker</code></a>.</p>
|
|
<p>Executors generally maintain a queue of “ready” tasks; <code>wake_by_ref</code> should place
|
|
the associated task onto this queue.</p>
|
|
<p>This function is similar to <a href="trait.ArcWake.html#method.wake" title="method futures_task::ArcWake::wake"><code>wake</code></a>, but must not consume the provided data
|
|
pointer.</p>
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.wake" class="method"><a class="src rightside" href="../src/futures_task/arc_wake.rs.html#31-33">Source</a><h4 class="code-header">fn <a href="#method.wake" class="fn">wake</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>)</h4></section></summary><div class="docblock"><p>Indicates that the associated task is ready to make progress and should
|
|
be <code>poll</code>ed.</p>
|
|
<p>This function can be called from an arbitrary thread, including threads which
|
|
did not create the <code>ArcWake</code> based <a href="https://doc.rust-lang.org/1.93.1/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>Waker</code></a>.</p>
|
|
<p>Executors generally maintain a queue of “ready” tasks; <code>wake</code> should place
|
|
the associated task onto this queue.</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.93.1/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/futures_task/arc_wake/trait.ArcWake.js" async></script></section></div></main></body></html> |