| <!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."><meta name="keywords" content="rust, rustlang, rust-lang, ArcWake"><title>ArcWake in futures_util::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="sidebar-items.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 trait"><!--[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_util/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_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">ArcWake</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.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">wake</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In futures_util::task</a></h2></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">Trait <a href="../index.html">futures_util</a>::<wbr><a href="index.html">task</a>::<wbr><a class="trait" href="#">ArcWake</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_task/arc_wake.rs.html#20">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait ArcWake: Send + Sync { |
| fn <a href="#tymethod.wake_by_ref" class="fnname">wake_by_ref</a>(arc_self: &Arc<Self>); |
| |
| fn <a href="#method.wake" class="fnname">wake</a>(self: Arc<Self>) { ... } |
| }</code></pre></div><details class="rustdoc-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="std::task::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="std::task::Waker"><code>Waker</code></a>:</p> |
| <ul> |
| <li><a href="fn.waker.html"><code>waker</code></a> converts <code>Arc<impl ArcWake></code> into <a href="std::task::Waker"><code>Waker</code></a>.</li> |
| <li><a href="fn.waker_ref.html"><code>waker_ref</code></a> converts <code>&Arc<impl ArcWake></code> into <a href="struct.WakerRef.html"><code>WakerRef</code></a> that |
| provides access to a <a href="std::task::Waker"><code>&Waker</code></a>.</li> |
| </ul> |
| </div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.wake_by_ref" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_task/arc_wake.rs.html#48">source</a><h4 class="code-header">fn <a href="#tymethod.wake_by_ref" class="fnname">wake_by_ref</a>(arc_self: &Arc<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="std::task::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"><code>wake</code></a>, but must not consume the provided data |
| pointer.</p> |
| </div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.wake" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_task/arc_wake.rs.html#31">source</a><h4 class="code-header">fn <a href="#method.wake" class="fnname">wake</a>(self: Arc<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="std::task::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="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../../implementors/futures_task/arc_wake/trait.ArcWake.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
