| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/futures-task-0.3.28/src/arc_wake.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>arc_wake.rs - source</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="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../futures_task/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../futures_task/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>alloc::sync::Arc; |
| |
| <span class="doccomment">/// A way of waking up a specific task. |
| /// |
| /// By implementing this trait, types that are expected to be wrapped in an `Arc` |
| /// can be converted into [`Waker`] objects. |
| /// Those Wakers can be used to signal executors that a task it owns |
| /// is ready to be `poll`ed again. |
| /// |
| /// Currently, there are two ways to convert `ArcWake` into [`Waker`]: |
| /// |
| /// * [`waker`](super::waker()) converts `Arc<impl ArcWake>` into [`Waker`]. |
| /// * [`waker_ref`](super::waker_ref()) converts `&Arc<impl ArcWake>` into [`WakerRef`] that |
| /// provides access to a [`&Waker`][`Waker`]. |
| /// |
| /// [`Waker`]: std::task::Waker |
| /// [`WakerRef`]: super::WakerRef |
| </span><span class="comment">// Note: Send + Sync required because `Arc<T>` doesn't automatically imply |
| // those bounds, but `Waker` implements them. |
| </span><span class="kw">pub trait </span>ArcWake: Send + Sync { |
| <span class="doccomment">/// Indicates that the associated task is ready to make progress and should |
| /// be `poll`ed. |
| /// |
| /// This function can be called from an arbitrary thread, including threads which |
| /// did not create the `ArcWake` based [`Waker`]. |
| /// |
| /// Executors generally maintain a queue of "ready" tasks; `wake` should place |
| /// the associated task onto this queue. |
| /// |
| /// [`Waker`]: std::task::Waker |
| </span><span class="kw">fn </span>wake(<span class="self">self</span>: Arc<<span class="self">Self</span>>) { |
| <span class="self">Self</span>::wake_by_ref(<span class="kw-2">&</span><span class="self">self</span>) |
| } |
| |
| <span class="doccomment">/// Indicates that the associated task is ready to make progress and should |
| /// be `poll`ed. |
| /// |
| /// This function can be called from an arbitrary thread, including threads which |
| /// did not create the `ArcWake` based [`Waker`]. |
| /// |
| /// Executors generally maintain a queue of "ready" tasks; `wake_by_ref` should place |
| /// the associated task onto this queue. |
| /// |
| /// This function is similar to [`wake`](ArcWake::wake), but must not consume the provided data |
| /// pointer. |
| /// |
| /// [`Waker`]: std::task::Waker |
| </span><span class="kw">fn </span>wake_by_ref(arc_self: <span class="kw-2">&</span>Arc<<span class="self">Self</span>>); |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures_task" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
