blob: b5cf612cfb03885de18b7f37055066a7ffb80949 [file] [log] [blame]
<!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/git/checkouts/tokio-377c595163f99a10/dfe252d/tokio/src/util/wake.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>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="../../../tokio/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="../../../tokio/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>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::loom::sync::Arc;
<span class="kw">use </span>std::marker::PhantomData;
<span class="kw">use </span>std::mem::ManuallyDrop;
<span class="kw">use </span>std::ops::Deref;
<span class="kw">use </span>std::task::{RawWaker, RawWakerVTable, Waker};
<span class="doccomment">/// Simplified waking interface based on Arcs.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">trait </span>Wake: Send + Sync + Sized + <span class="lifetime">&#39;static </span>{
<span class="doccomment">/// Wake by value.
</span><span class="kw">fn </span>wake(arc_self: Arc&lt;<span class="self">Self</span>&gt;);
<span class="doccomment">/// Wake by reference.
</span><span class="kw">fn </span>wake_by_ref(arc_self: <span class="kw-2">&amp;</span>Arc&lt;<span class="self">Self</span>&gt;);
}
<span class="doccomment">/// A `Waker` that is only valid for a given lifetime.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>WakerRef&lt;<span class="lifetime">&#39;a</span>&gt; {
waker: ManuallyDrop&lt;Waker&gt;,
_p: PhantomData&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>()&gt;,
}
<span class="kw">impl </span>Deref <span class="kw">for </span>WakerRef&lt;<span class="lifetime">&#39;_</span>&gt; {
<span class="kw">type </span>Target = Waker;
<span class="kw">fn </span>deref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>Waker {
<span class="kw-2">&amp;</span><span class="self">self</span>.waker
}
}
<span class="doccomment">/// Creates a reference to a `Waker` from a reference to `Arc&lt;impl Wake&gt;`.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>waker_ref&lt;W: Wake&gt;(wake: <span class="kw-2">&amp;</span>Arc&lt;W&gt;) -&gt; WakerRef&lt;<span class="lifetime">&#39;_</span>&gt; {
<span class="kw">let </span>ptr = Arc::as_ptr(wake) <span class="kw">as </span><span class="kw-2">*const </span>();
<span class="kw">let </span>waker = <span class="kw">unsafe </span>{ Waker::from_raw(RawWaker::new(ptr, waker_vtable::&lt;W&gt;())) };
WakerRef {
waker: ManuallyDrop::new(waker),
_p: PhantomData,
}
}
<span class="kw">fn </span>waker_vtable&lt;W: Wake&gt;() -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>RawWakerVTable {
<span class="kw-2">&amp;</span>RawWakerVTable::new(
clone_arc_raw::&lt;W&gt;,
wake_arc_raw::&lt;W&gt;,
wake_by_ref_arc_raw::&lt;W&gt;,
drop_arc_raw::&lt;W&gt;,
)
}
<span class="kw">unsafe fn </span>inc_ref_count&lt;T: Wake&gt;(data: <span class="kw-2">*const </span>()) {
<span class="comment">// Retain Arc, but don&#39;t touch refcount by wrapping in ManuallyDrop
</span><span class="kw">let </span>arc = ManuallyDrop::new(Arc::&lt;T&gt;::from_raw(data <span class="kw">as </span><span class="kw-2">*const </span>T));
<span class="comment">// Now increase refcount, but don&#39;t drop new refcount either
</span><span class="kw">let </span>_arc_clone: ManuallyDrop&lt;<span class="kw">_</span>&gt; = arc.clone();
}
<span class="kw">unsafe fn </span>clone_arc_raw&lt;T: Wake&gt;(data: <span class="kw-2">*const </span>()) -&gt; RawWaker {
inc_ref_count::&lt;T&gt;(data);
RawWaker::new(data, waker_vtable::&lt;T&gt;())
}
<span class="kw">unsafe fn </span>wake_arc_raw&lt;T: Wake&gt;(data: <span class="kw-2">*const </span>()) {
<span class="kw">let </span>arc: Arc&lt;T&gt; = Arc::from_raw(data <span class="kw">as </span><span class="kw-2">*const </span>T);
Wake::wake(arc);
}
<span class="comment">// used by `waker_ref`
</span><span class="kw">unsafe fn </span>wake_by_ref_arc_raw&lt;T: Wake&gt;(data: <span class="kw-2">*const </span>()) {
<span class="comment">// Retain Arc, but don&#39;t touch refcount by wrapping in ManuallyDrop
</span><span class="kw">let </span>arc = ManuallyDrop::new(Arc::&lt;T&gt;::from_raw(data <span class="kw">as </span><span class="kw-2">*const </span>T));
Wake::wake_by_ref(<span class="kw-2">&amp;</span>arc);
}
<span class="kw">unsafe fn </span>drop_arc_raw&lt;T: Wake&gt;(data: <span class="kw-2">*const </span>()) {
drop(Arc::&lt;T&gt;::from_raw(data <span class="kw">as </span><span class="kw-2">*const </span>T))
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>