Adding large folders

This commit is contained in:
2026-02-26 12:00:21 -05:00
parent 5400d82acd
commit 49701c85ad
47332 changed files with 1942573 additions and 0 deletions

View File

@@ -0,0 +1,50 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/futures-task-0.3.32/src/arc_wake.rs`."><title>arc_wake.rs - source</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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">futures_task/</div>arc_wake.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>alloc::sync::Arc;
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a><span class="doccomment">/// A way of waking up a specific task.
<a href=#4 id=4 data-nosnippet>4</a>///
<a href=#5 id=5 data-nosnippet>5</a>/// By implementing this trait, types that are expected to be wrapped in an `Arc`
<a href=#6 id=6 data-nosnippet>6</a>/// can be converted into [`Waker`] objects.
<a href=#7 id=7 data-nosnippet>7</a>/// Those Wakers can be used to signal executors that a task it owns
<a href=#8 id=8 data-nosnippet>8</a>/// is ready to be `poll`ed again.
<a href=#9 id=9 data-nosnippet>9</a>///
<a href=#10 id=10 data-nosnippet>10</a>/// Currently, there are two ways to convert `ArcWake` into [`Waker`]:
<a href=#11 id=11 data-nosnippet>11</a>///
<a href=#12 id=12 data-nosnippet>12</a>/// * [`waker`](super::waker()) converts `Arc&lt;impl ArcWake&gt;` into [`Waker`].
<a href=#13 id=13 data-nosnippet>13</a>/// * [`waker_ref`](super::waker_ref()) converts `&amp;Arc&lt;impl ArcWake&gt;` into [`WakerRef`] that
<a href=#14 id=14 data-nosnippet>14</a>/// provides access to a [`&amp;Waker`][`Waker`].
<a href=#15 id=15 data-nosnippet>15</a>///
<a href=#16 id=16 data-nosnippet>16</a>/// [`Waker`]: std::task::Waker
<a href=#17 id=17 data-nosnippet>17</a>/// [`WakerRef`]: super::WakerRef
<a href=#18 id=18 data-nosnippet>18</a></span><span class="comment">// Note: Send + Sync required because `Arc&lt;T&gt;` doesn't automatically imply
<a href=#19 id=19 data-nosnippet>19</a>// those bounds, but `Waker` implements them.
<a href=#20 id=20 data-nosnippet>20</a></span><span class="kw">pub trait </span>ArcWake: Send + Sync {
<a href=#21 id=21 data-nosnippet>21</a> <span class="doccomment">/// Indicates that the associated task is ready to make progress and should
<a href=#22 id=22 data-nosnippet>22</a> /// be `poll`ed.
<a href=#23 id=23 data-nosnippet>23</a> ///
<a href=#24 id=24 data-nosnippet>24</a> /// This function can be called from an arbitrary thread, including threads which
<a href=#25 id=25 data-nosnippet>25</a> /// did not create the `ArcWake` based [`Waker`].
<a href=#26 id=26 data-nosnippet>26</a> ///
<a href=#27 id=27 data-nosnippet>27</a> /// Executors generally maintain a queue of "ready" tasks; `wake` should place
<a href=#28 id=28 data-nosnippet>28</a> /// the associated task onto this queue.
<a href=#29 id=29 data-nosnippet>29</a> ///
<a href=#30 id=30 data-nosnippet>30</a> /// [`Waker`]: std::task::Waker
<a href=#31 id=31 data-nosnippet>31</a> </span><span class="kw">fn </span>wake(<span class="self">self</span>: Arc&lt;<span class="self">Self</span>&gt;) {
<a href=#32 id=32 data-nosnippet>32</a> <span class="self">Self</span>::wake_by_ref(<span class="kw-2">&amp;</span><span class="self">self</span>)
<a href=#33 id=33 data-nosnippet>33</a> }
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a> <span class="doccomment">/// Indicates that the associated task is ready to make progress and should
<a href=#36 id=36 data-nosnippet>36</a> /// be `poll`ed.
<a href=#37 id=37 data-nosnippet>37</a> ///
<a href=#38 id=38 data-nosnippet>38</a> /// This function can be called from an arbitrary thread, including threads which
<a href=#39 id=39 data-nosnippet>39</a> /// did not create the `ArcWake` based [`Waker`].
<a href=#40 id=40 data-nosnippet>40</a> ///
<a href=#41 id=41 data-nosnippet>41</a> /// Executors generally maintain a queue of "ready" tasks; `wake_by_ref` should place
<a href=#42 id=42 data-nosnippet>42</a> /// the associated task onto this queue.
<a href=#43 id=43 data-nosnippet>43</a> ///
<a href=#44 id=44 data-nosnippet>44</a> /// This function is similar to [`wake`](ArcWake::wake), but must not consume the provided data
<a href=#45 id=45 data-nosnippet>45</a> /// pointer.
<a href=#46 id=46 data-nosnippet>46</a> ///
<a href=#47 id=47 data-nosnippet>47</a> /// [`Waker`]: std::task::Waker
<a href=#48 id=48 data-nosnippet>48</a> </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;);
<a href=#49 id=49 data-nosnippet>49</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,336 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/futures-task-0.3.32/src/future_obj.rs`."><title>future_obj.rs - source</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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">futures_task/</div>future_obj.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>core::{
<a href=#2 id=2 data-nosnippet>2</a> fmt,
<a href=#3 id=3 data-nosnippet>3</a> future::Future,
<a href=#4 id=4 data-nosnippet>4</a> marker::PhantomData,
<a href=#5 id=5 data-nosnippet>5</a> mem,
<a href=#6 id=6 data-nosnippet>6</a> pin::Pin,
<a href=#7 id=7 data-nosnippet>7</a> task::{Context, Poll},
<a href=#8 id=8 data-nosnippet>8</a>};
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="doccomment">/// A custom trait object for polling futures, roughly akin to
<a href=#11 id=11 data-nosnippet>11</a>/// `Box&lt;dyn Future&lt;Output = T&gt; + 'a&gt;`.
<a href=#12 id=12 data-nosnippet>12</a>///
<a href=#13 id=13 data-nosnippet>13</a>/// This custom trait object was introduced as currently it is not possible to
<a href=#14 id=14 data-nosnippet>14</a>/// take `dyn Trait` by value and `Box&lt;dyn Trait&gt;` is not available in no_std
<a href=#15 id=15 data-nosnippet>15</a>/// contexts.
<a href=#16 id=16 data-nosnippet>16</a></span><span class="kw">pub struct </span>LocalFutureObj&lt;<span class="lifetime">'a</span>, T&gt; {
<a href=#17 id=17 data-nosnippet>17</a> future: <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'static</span>),
<a href=#18 id=18 data-nosnippet>18</a> drop_fn: <span class="kw">unsafe fn</span>(<span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'static</span>)),
<a href=#19 id=19 data-nosnippet>19</a> _marker: PhantomData&lt;<span class="kw-2">&amp;</span><span class="lifetime">'a </span>()&gt;,
<a href=#20 id=20 data-nosnippet>20</a>}
<a href=#21 id=21 data-nosnippet>21</a>
<a href=#22 id=22 data-nosnippet>22</a><span class="comment">// As LocalFutureObj only holds pointers, even if we move it, the pointed to values won't move,
<a href=#23 id=23 data-nosnippet>23</a>// so this is safe as long as we don't provide any way for a user to directly access the pointers
<a href=#24 id=24 data-nosnippet>24</a>// and move their values.
<a href=#25 id=25 data-nosnippet>25</a></span><span class="kw">impl</span>&lt;T&gt; Unpin <span class="kw">for </span>LocalFutureObj&lt;<span class="lifetime">'_</span>, T&gt; {}
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a><span class="attr">#[allow(single_use_lifetimes)]
<a href=#28 id=28 data-nosnippet>28</a>#[allow(clippy::transmute_ptr_to_ptr)]
<a href=#29 id=29 data-nosnippet>29</a></span><span class="kw">unsafe fn </span>remove_future_lifetime&lt;<span class="lifetime">'a</span>, T&gt;(
<a href=#30 id=30 data-nosnippet>30</a> ptr: <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>),
<a href=#31 id=31 data-nosnippet>31</a>) -&gt; <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'static</span>) {
<a href=#32 id=32 data-nosnippet>32</a> <span class="kw">unsafe </span>{ mem::transmute(ptr) }
<a href=#33 id=33 data-nosnippet>33</a>}
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a><span class="attr">#[allow(single_use_lifetimes)]
<a href=#36 id=36 data-nosnippet>36</a></span><span class="kw">unsafe fn </span>remove_drop_lifetime&lt;<span class="lifetime">'a</span>, T&gt;(
<a href=#37 id=37 data-nosnippet>37</a> ptr: <span class="kw">unsafe fn</span>(<span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>)),
<a href=#38 id=38 data-nosnippet>38</a>) -&gt; <span class="kw">unsafe fn</span>(<span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'static</span>)) {
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw">unsafe </span>{ mem::transmute(ptr) }
<a href=#40 id=40 data-nosnippet>40</a>}
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a><span class="kw">impl</span>&lt;<span class="lifetime">'a</span>, T&gt; LocalFutureObj&lt;<span class="lifetime">'a</span>, T&gt; {
<a href=#43 id=43 data-nosnippet>43</a> <span class="doccomment">/// Create a `LocalFutureObj` from a custom trait object representation.
<a href=#44 id=44 data-nosnippet>44</a> </span><span class="attr">#[inline]
<a href=#45 id=45 data-nosnippet>45</a> </span><span class="kw">pub fn </span>new&lt;F: UnsafeFutureObj&lt;<span class="lifetime">'a</span>, T&gt; + <span class="lifetime">'a</span>&gt;(f: F) -&gt; <span class="self">Self </span>{
<a href=#46 id=46 data-nosnippet>46</a> <span class="self">Self </span>{
<a href=#47 id=47 data-nosnippet>47</a> future: <span class="kw">unsafe </span>{ remove_future_lifetime(f.into_raw()) },
<a href=#48 id=48 data-nosnippet>48</a> drop_fn: <span class="kw">unsafe </span>{ remove_drop_lifetime(F::drop) },
<a href=#49 id=49 data-nosnippet>49</a> _marker: PhantomData,
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a> }
<a href=#52 id=52 data-nosnippet>52</a>
<a href=#53 id=53 data-nosnippet>53</a> <span class="doccomment">/// Converts the `LocalFutureObj` into a `FutureObj`.
<a href=#54 id=54 data-nosnippet>54</a> ///
<a href=#55 id=55 data-nosnippet>55</a> /// # Safety
<a href=#56 id=56 data-nosnippet>56</a> ///
<a href=#57 id=57 data-nosnippet>57</a> /// To make this operation safe one has to ensure that the `UnsafeFutureObj`
<a href=#58 id=58 data-nosnippet>58</a> /// instance from which this `LocalFutureObj` was created actually
<a href=#59 id=59 data-nosnippet>59</a> /// implements `Send`.
<a href=#60 id=60 data-nosnippet>60</a> </span><span class="attr">#[inline]
<a href=#61 id=61 data-nosnippet>61</a> </span><span class="kw">pub unsafe fn </span>into_future_obj(<span class="self">self</span>) -&gt; FutureObj&lt;<span class="lifetime">'a</span>, T&gt; {
<a href=#62 id=62 data-nosnippet>62</a> FutureObj(<span class="self">self</span>)
<a href=#63 id=63 data-nosnippet>63</a> }
<a href=#64 id=64 data-nosnippet>64</a>}
<a href=#65 id=65 data-nosnippet>65</a>
<a href=#66 id=66 data-nosnippet>66</a><span class="kw">impl</span>&lt;T&gt; fmt::Debug <span class="kw">for </span>LocalFutureObj&lt;<span class="lifetime">'_</span>, T&gt; {
<a href=#67 id=67 data-nosnippet>67</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#68 id=68 data-nosnippet>68</a> f.debug_struct(<span class="string">"LocalFutureObj"</span>).finish()
<a href=#69 id=69 data-nosnippet>69</a> }
<a href=#70 id=70 data-nosnippet>70</a>}
<a href=#71 id=71 data-nosnippet>71</a>
<a href=#72 id=72 data-nosnippet>72</a><span class="kw">impl</span>&lt;<span class="lifetime">'a</span>, T&gt; From&lt;FutureObj&lt;<span class="lifetime">'a</span>, T&gt;&gt; <span class="kw">for </span>LocalFutureObj&lt;<span class="lifetime">'a</span>, T&gt; {
<a href=#73 id=73 data-nosnippet>73</a> <span class="attr">#[inline]
<a href=#74 id=74 data-nosnippet>74</a> </span><span class="kw">fn </span>from(f: FutureObj&lt;<span class="lifetime">'a</span>, T&gt;) -&gt; <span class="self">Self </span>{
<a href=#75 id=75 data-nosnippet>75</a> f.<span class="number">0
<a href=#76 id=76 data-nosnippet>76</a> </span>}
<a href=#77 id=77 data-nosnippet>77</a>}
<a href=#78 id=78 data-nosnippet>78</a>
<a href=#79 id=79 data-nosnippet>79</a><span class="kw">impl</span>&lt;T&gt; Future <span class="kw">for </span>LocalFutureObj&lt;<span class="lifetime">'_</span>, T&gt; {
<a href=#80 id=80 data-nosnippet>80</a> <span class="kw">type </span>Output = T;
<a href=#81 id=81 data-nosnippet>81</a>
<a href=#82 id=82 data-nosnippet>82</a> <span class="attr">#[inline]
<a href=#83 id=83 data-nosnippet>83</a> </span><span class="kw">fn </span>poll(<span class="kw-2">mut </span><span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">'_</span>&gt;) -&gt; Poll&lt;T&gt; {
<a href=#84 id=84 data-nosnippet>84</a> <span class="kw">unsafe </span>{ Pin::new_unchecked(<span class="kw-2">&amp;mut *</span><span class="self">self</span>.future).poll(cx) }
<a href=#85 id=85 data-nosnippet>85</a> }
<a href=#86 id=86 data-nosnippet>86</a>}
<a href=#87 id=87 data-nosnippet>87</a>
<a href=#88 id=88 data-nosnippet>88</a><span class="kw">impl</span>&lt;T&gt; Drop <span class="kw">for </span>LocalFutureObj&lt;<span class="lifetime">'_</span>, T&gt; {
<a href=#89 id=89 data-nosnippet>89</a> <span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#90 id=90 data-nosnippet>90</a> <span class="kw">unsafe </span>{ (<span class="self">self</span>.drop_fn)(<span class="self">self</span>.future) }
<a href=#91 id=91 data-nosnippet>91</a> }
<a href=#92 id=92 data-nosnippet>92</a>}
<a href=#93 id=93 data-nosnippet>93</a>
<a href=#94 id=94 data-nosnippet>94</a><span class="doccomment">/// A custom trait object for polling futures, roughly akin to
<a href=#95 id=95 data-nosnippet>95</a>/// `Box&lt;dyn Future&lt;Output = T&gt; + Send + 'a&gt;`.
<a href=#96 id=96 data-nosnippet>96</a>///
<a href=#97 id=97 data-nosnippet>97</a>/// This custom trait object was introduced as currently it is not possible to
<a href=#98 id=98 data-nosnippet>98</a>/// take `dyn Trait` by value and `Box&lt;dyn Trait&gt;` is not available in no_std
<a href=#99 id=99 data-nosnippet>99</a>/// contexts.
<a href=#100 id=100 data-nosnippet>100</a>///
<a href=#101 id=101 data-nosnippet>101</a>/// You should generally not need to use this type outside of `no_std` or when
<a href=#102 id=102 data-nosnippet>102</a>/// implementing `Spawn`, consider using `BoxFuture` instead.
<a href=#103 id=103 data-nosnippet>103</a></span><span class="kw">pub struct </span>FutureObj&lt;<span class="lifetime">'a</span>, T&gt;(LocalFutureObj&lt;<span class="lifetime">'a</span>, T&gt;);
<a href=#104 id=104 data-nosnippet>104</a>
<a href=#105 id=105 data-nosnippet>105</a><span class="kw">impl</span>&lt;T&gt; Unpin <span class="kw">for </span>FutureObj&lt;<span class="lifetime">'_</span>, T&gt; {}
<a href=#106 id=106 data-nosnippet>106</a><span class="kw">unsafe impl</span>&lt;T&gt; Send <span class="kw">for </span>FutureObj&lt;<span class="lifetime">'_</span>, T&gt; {}
<a href=#107 id=107 data-nosnippet>107</a>
<a href=#108 id=108 data-nosnippet>108</a><span class="kw">impl</span>&lt;<span class="lifetime">'a</span>, T&gt; FutureObj&lt;<span class="lifetime">'a</span>, T&gt; {
<a href=#109 id=109 data-nosnippet>109</a> <span class="doccomment">/// Create a `FutureObj` from a custom trait object representation.
<a href=#110 id=110 data-nosnippet>110</a> </span><span class="attr">#[inline]
<a href=#111 id=111 data-nosnippet>111</a> </span><span class="kw">pub fn </span>new&lt;F: UnsafeFutureObj&lt;<span class="lifetime">'a</span>, T&gt; + Send&gt;(f: F) -&gt; <span class="self">Self </span>{
<a href=#112 id=112 data-nosnippet>112</a> <span class="self">Self</span>(LocalFutureObj::new(f))
<a href=#113 id=113 data-nosnippet>113</a> }
<a href=#114 id=114 data-nosnippet>114</a>}
<a href=#115 id=115 data-nosnippet>115</a>
<a href=#116 id=116 data-nosnippet>116</a><span class="kw">impl</span>&lt;T&gt; fmt::Debug <span class="kw">for </span>FutureObj&lt;<span class="lifetime">'_</span>, T&gt; {
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#118 id=118 data-nosnippet>118</a> f.debug_struct(<span class="string">"FutureObj"</span>).finish()
<a href=#119 id=119 data-nosnippet>119</a> }
<a href=#120 id=120 data-nosnippet>120</a>}
<a href=#121 id=121 data-nosnippet>121</a>
<a href=#122 id=122 data-nosnippet>122</a><span class="kw">impl</span>&lt;T&gt; Future <span class="kw">for </span>FutureObj&lt;<span class="lifetime">'_</span>, T&gt; {
<a href=#123 id=123 data-nosnippet>123</a> <span class="kw">type </span>Output = T;
<a href=#124 id=124 data-nosnippet>124</a>
<a href=#125 id=125 data-nosnippet>125</a> <span class="attr">#[inline]
<a href=#126 id=126 data-nosnippet>126</a> </span><span class="kw">fn </span>poll(<span class="kw-2">mut </span><span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">'_</span>&gt;) -&gt; Poll&lt;T&gt; {
<a href=#127 id=127 data-nosnippet>127</a> Pin::new(<span class="kw-2">&amp;mut </span><span class="self">self</span>.<span class="number">0</span>).poll(cx)
<a href=#128 id=128 data-nosnippet>128</a> }
<a href=#129 id=129 data-nosnippet>129</a>}
<a href=#130 id=130 data-nosnippet>130</a>
<a href=#131 id=131 data-nosnippet>131</a><span class="doccomment">/// A custom implementation of a future trait object for `FutureObj`, providing
<a href=#132 id=132 data-nosnippet>132</a>/// a vtable with drop support.
<a href=#133 id=133 data-nosnippet>133</a>///
<a href=#134 id=134 data-nosnippet>134</a>/// This custom representation is typically used only in `no_std` contexts,
<a href=#135 id=135 data-nosnippet>135</a>/// where the default `Box`-based implementation is not available.
<a href=#136 id=136 data-nosnippet>136</a>///
<a href=#137 id=137 data-nosnippet>137</a>/// # Safety
<a href=#138 id=138 data-nosnippet>138</a>///
<a href=#139 id=139 data-nosnippet>139</a>/// See the safety notes on individual methods for what guarantees an
<a href=#140 id=140 data-nosnippet>140</a>/// implementor must provide.
<a href=#141 id=141 data-nosnippet>141</a></span><span class="kw">pub unsafe trait </span>UnsafeFutureObj&lt;<span class="lifetime">'a</span>, T&gt;: <span class="lifetime">'a </span>{
<a href=#142 id=142 data-nosnippet>142</a> <span class="doccomment">/// Convert an owned instance into a (conceptually owned) fat pointer.
<a href=#143 id=143 data-nosnippet>143</a> ///
<a href=#144 id=144 data-nosnippet>144</a> /// # Safety
<a href=#145 id=145 data-nosnippet>145</a> ///
<a href=#146 id=146 data-nosnippet>146</a> /// ## Implementor
<a href=#147 id=147 data-nosnippet>147</a> ///
<a href=#148 id=148 data-nosnippet>148</a> /// The trait implementor must guarantee that it is safe to convert the
<a href=#149 id=149 data-nosnippet>149</a> /// provided `*mut (dyn Future&lt;Output = T&gt; + 'a)` into a `Pin&lt;&amp;mut (dyn
<a href=#150 id=150 data-nosnippet>150</a> /// Future&lt;Output = T&gt; + 'a)&gt;` and call methods on it, non-reentrantly,
<a href=#151 id=151 data-nosnippet>151</a> /// until `UnsafeFutureObj::drop` is called with it.
<a href=#152 id=152 data-nosnippet>152</a> </span><span class="attr">#[allow(clippy::unnecessary_safety_doc)]
<a href=#153 id=153 data-nosnippet>153</a> </span><span class="kw">fn </span>into_raw(<span class="self">self</span>) -&gt; <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>);
<a href=#154 id=154 data-nosnippet>154</a>
<a href=#155 id=155 data-nosnippet>155</a> <span class="doccomment">/// Drops the future represented by the given fat pointer.
<a href=#156 id=156 data-nosnippet>156</a> ///
<a href=#157 id=157 data-nosnippet>157</a> /// # Safety
<a href=#158 id=158 data-nosnippet>158</a> ///
<a href=#159 id=159 data-nosnippet>159</a> /// ## Implementor
<a href=#160 id=160 data-nosnippet>160</a> ///
<a href=#161 id=161 data-nosnippet>161</a> /// The trait implementor must guarantee that it is safe to call this
<a href=#162 id=162 data-nosnippet>162</a> /// function once per `into_raw` invocation.
<a href=#163 id=163 data-nosnippet>163</a> ///
<a href=#164 id=164 data-nosnippet>164</a> /// ## Caller
<a href=#165 id=165 data-nosnippet>165</a> ///
<a href=#166 id=166 data-nosnippet>166</a> /// The caller must ensure:
<a href=#167 id=167 data-nosnippet>167</a> ///
<a href=#168 id=168 data-nosnippet>168</a> /// * the pointer passed was obtained from an `into_raw` invocation from
<a href=#169 id=169 data-nosnippet>169</a> /// this same trait object
<a href=#170 id=170 data-nosnippet>170</a> /// * the pointer is not currently in use as a `Pin&lt;&amp;mut (dyn Future&lt;Output
<a href=#171 id=171 data-nosnippet>171</a> /// = T&gt; + 'a)&gt;`
<a href=#172 id=172 data-nosnippet>172</a> /// * the pointer must not be used again after this function is called
<a href=#173 id=173 data-nosnippet>173</a> </span><span class="kw">unsafe fn </span>drop(ptr: <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>));
<a href=#174 id=174 data-nosnippet>174</a>}
<a href=#175 id=175 data-nosnippet>175</a>
<a href=#176 id=176 data-nosnippet>176</a><span class="kw">unsafe impl</span>&lt;<span class="lifetime">'a</span>, T, F&gt; UnsafeFutureObj&lt;<span class="lifetime">'a</span>, T&gt; <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">'a </span><span class="kw-2">mut </span>F
<a href=#177 id=177 data-nosnippet>177</a><span class="kw">where
<a href=#178 id=178 data-nosnippet>178</a> </span>F: Future&lt;Output = T&gt; + Unpin + <span class="lifetime">'a</span>,
<a href=#179 id=179 data-nosnippet>179</a>{
<a href=#180 id=180 data-nosnippet>180</a> <span class="kw">fn </span>into_raw(<span class="self">self</span>) -&gt; <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>) {
<a href=#181 id=181 data-nosnippet>181</a> <span class="self">self </span><span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">dyn </span>Future&lt;Output = T&gt;
<a href=#182 id=182 data-nosnippet>182</a> }
<a href=#183 id=183 data-nosnippet>183</a>
<a href=#184 id=184 data-nosnippet>184</a> <span class="kw">unsafe fn </span>drop(_ptr: <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>)) {}
<a href=#185 id=185 data-nosnippet>185</a>}
<a href=#186 id=186 data-nosnippet>186</a>
<a href=#187 id=187 data-nosnippet>187</a><span class="kw">unsafe impl</span>&lt;<span class="lifetime">'a</span>, T&gt; UnsafeFutureObj&lt;<span class="lifetime">'a</span>, T&gt; <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">'a </span><span class="kw-2">mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + Unpin + <span class="lifetime">'a</span>) {
<a href=#188 id=188 data-nosnippet>188</a> <span class="kw">fn </span>into_raw(<span class="self">self</span>) -&gt; <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>) {
<a href=#189 id=189 data-nosnippet>189</a> <span class="self">self </span><span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">dyn </span>Future&lt;Output = T&gt;
<a href=#190 id=190 data-nosnippet>190</a> }
<a href=#191 id=191 data-nosnippet>191</a>
<a href=#192 id=192 data-nosnippet>192</a> <span class="kw">unsafe fn </span>drop(_ptr: <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>)) {}
<a href=#193 id=193 data-nosnippet>193</a>}
<a href=#194 id=194 data-nosnippet>194</a>
<a href=#195 id=195 data-nosnippet>195</a><span class="kw">unsafe impl</span>&lt;<span class="lifetime">'a</span>, T, F&gt; UnsafeFutureObj&lt;<span class="lifetime">'a</span>, T&gt; <span class="kw">for </span>Pin&lt;<span class="kw-2">&amp;</span><span class="lifetime">'a </span><span class="kw-2">mut </span>F&gt;
<a href=#196 id=196 data-nosnippet>196</a><span class="kw">where
<a href=#197 id=197 data-nosnippet>197</a> </span>F: Future&lt;Output = T&gt; + <span class="lifetime">'a</span>,
<a href=#198 id=198 data-nosnippet>198</a>{
<a href=#199 id=199 data-nosnippet>199</a> <span class="kw">fn </span>into_raw(<span class="self">self</span>) -&gt; <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>) {
<a href=#200 id=200 data-nosnippet>200</a> <span class="kw">unsafe </span>{ <span class="self">self</span>.get_unchecked_mut() <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">dyn </span>Future&lt;Output = T&gt; }
<a href=#201 id=201 data-nosnippet>201</a> }
<a href=#202 id=202 data-nosnippet>202</a>
<a href=#203 id=203 data-nosnippet>203</a> <span class="kw">unsafe fn </span>drop(_ptr: <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>)) {}
<a href=#204 id=204 data-nosnippet>204</a>}
<a href=#205 id=205 data-nosnippet>205</a>
<a href=#206 id=206 data-nosnippet>206</a><span class="kw">unsafe impl</span>&lt;<span class="lifetime">'a</span>, T&gt; UnsafeFutureObj&lt;<span class="lifetime">'a</span>, T&gt; <span class="kw">for </span>Pin&lt;<span class="kw-2">&amp;</span><span class="lifetime">'a </span><span class="kw-2">mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>)&gt; {
<a href=#207 id=207 data-nosnippet>207</a> <span class="kw">fn </span>into_raw(<span class="self">self</span>) -&gt; <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>) {
<a href=#208 id=208 data-nosnippet>208</a> <span class="kw">unsafe </span>{ <span class="self">self</span>.get_unchecked_mut() <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">dyn </span>Future&lt;Output = T&gt; }
<a href=#209 id=209 data-nosnippet>209</a> }
<a href=#210 id=210 data-nosnippet>210</a>
<a href=#211 id=211 data-nosnippet>211</a> <span class="kw">unsafe fn </span>drop(_ptr: <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>)) {}
<a href=#212 id=212 data-nosnippet>212</a>}
<a href=#213 id=213 data-nosnippet>213</a>
<a href=#214 id=214 data-nosnippet>214</a><span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#215 id=215 data-nosnippet>215</a></span><span class="kw">mod </span>if_alloc {
<a href=#216 id=216 data-nosnippet>216</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#217 id=217 data-nosnippet>217</a> <span class="kw">use </span>alloc::boxed::Box;
<a href=#218 id=218 data-nosnippet>218</a>
<a href=#219 id=219 data-nosnippet>219</a> <span class="kw">unsafe impl</span>&lt;<span class="lifetime">'a</span>, T, F&gt; UnsafeFutureObj&lt;<span class="lifetime">'a</span>, T&gt; <span class="kw">for </span>Box&lt;F&gt;
<a href=#220 id=220 data-nosnippet>220</a> <span class="kw">where
<a href=#221 id=221 data-nosnippet>221</a> </span>F: Future&lt;Output = T&gt; + <span class="lifetime">'a</span>,
<a href=#222 id=222 data-nosnippet>222</a> {
<a href=#223 id=223 data-nosnippet>223</a> <span class="kw">fn </span>into_raw(<span class="self">self</span>) -&gt; <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>) {
<a href=#224 id=224 data-nosnippet>224</a> Box::into_raw(<span class="self">self</span>)
<a href=#225 id=225 data-nosnippet>225</a> }
<a href=#226 id=226 data-nosnippet>226</a>
<a href=#227 id=227 data-nosnippet>227</a> <span class="kw">unsafe fn </span>drop(ptr: <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>)) {
<a href=#228 id=228 data-nosnippet>228</a> drop(<span class="kw">unsafe </span>{ Box::from_raw(ptr.cast::&lt;F&gt;()) })
<a href=#229 id=229 data-nosnippet>229</a> }
<a href=#230 id=230 data-nosnippet>230</a> }
<a href=#231 id=231 data-nosnippet>231</a>
<a href=#232 id=232 data-nosnippet>232</a> <span class="kw">unsafe impl</span>&lt;<span class="lifetime">'a</span>, T: <span class="lifetime">'a</span>&gt; UnsafeFutureObj&lt;<span class="lifetime">'a</span>, T&gt; <span class="kw">for </span>Box&lt;<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>&gt; {
<a href=#233 id=233 data-nosnippet>233</a> <span class="kw">fn </span>into_raw(<span class="self">self</span>) -&gt; <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>) {
<a href=#234 id=234 data-nosnippet>234</a> Box::into_raw(<span class="self">self</span>)
<a href=#235 id=235 data-nosnippet>235</a> }
<a href=#236 id=236 data-nosnippet>236</a>
<a href=#237 id=237 data-nosnippet>237</a> <span class="kw">unsafe fn </span>drop(ptr: <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>)) {
<a href=#238 id=238 data-nosnippet>238</a> drop(<span class="kw">unsafe </span>{ Box::from_raw(ptr) })
<a href=#239 id=239 data-nosnippet>239</a> }
<a href=#240 id=240 data-nosnippet>240</a> }
<a href=#241 id=241 data-nosnippet>241</a>
<a href=#242 id=242 data-nosnippet>242</a> <span class="kw">unsafe impl</span>&lt;<span class="lifetime">'a</span>, T: <span class="lifetime">'a</span>&gt; UnsafeFutureObj&lt;<span class="lifetime">'a</span>, T&gt; <span class="kw">for </span>Box&lt;<span class="kw">dyn </span>Future&lt;Output = T&gt; + Send + <span class="lifetime">'a</span>&gt; {
<a href=#243 id=243 data-nosnippet>243</a> <span class="kw">fn </span>into_raw(<span class="self">self</span>) -&gt; <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>) {
<a href=#244 id=244 data-nosnippet>244</a> Box::into_raw(<span class="self">self</span>)
<a href=#245 id=245 data-nosnippet>245</a> }
<a href=#246 id=246 data-nosnippet>246</a>
<a href=#247 id=247 data-nosnippet>247</a> <span class="kw">unsafe fn </span>drop(ptr: <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>)) {
<a href=#248 id=248 data-nosnippet>248</a> drop(<span class="kw">unsafe </span>{ Box::from_raw(ptr) })
<a href=#249 id=249 data-nosnippet>249</a> }
<a href=#250 id=250 data-nosnippet>250</a> }
<a href=#251 id=251 data-nosnippet>251</a>
<a href=#252 id=252 data-nosnippet>252</a> <span class="kw">unsafe impl</span>&lt;<span class="lifetime">'a</span>, T, F&gt; UnsafeFutureObj&lt;<span class="lifetime">'a</span>, T&gt; <span class="kw">for </span>Pin&lt;Box&lt;F&gt;&gt;
<a href=#253 id=253 data-nosnippet>253</a> <span class="kw">where
<a href=#254 id=254 data-nosnippet>254</a> </span>F: Future&lt;Output = T&gt; + <span class="lifetime">'a</span>,
<a href=#255 id=255 data-nosnippet>255</a> {
<a href=#256 id=256 data-nosnippet>256</a> <span class="kw">fn </span>into_raw(<span class="self">self</span>) -&gt; <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>) {
<a href=#257 id=257 data-nosnippet>257</a> <span class="kw">let </span><span class="kw-2">mut </span>this = mem::ManuallyDrop::new(<span class="self">self</span>);
<a href=#258 id=258 data-nosnippet>258</a> <span class="kw">unsafe </span>{ this.as_mut().get_unchecked_mut() <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_ </span>}
<a href=#259 id=259 data-nosnippet>259</a> }
<a href=#260 id=260 data-nosnippet>260</a>
<a href=#261 id=261 data-nosnippet>261</a> <span class="kw">unsafe fn </span>drop(ptr: <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>)) {
<a href=#262 id=262 data-nosnippet>262</a> drop(Pin::from(<span class="kw">unsafe </span>{ Box::from_raw(ptr) }))
<a href=#263 id=263 data-nosnippet>263</a> }
<a href=#264 id=264 data-nosnippet>264</a> }
<a href=#265 id=265 data-nosnippet>265</a>
<a href=#266 id=266 data-nosnippet>266</a> <span class="kw">unsafe impl</span>&lt;<span class="lifetime">'a</span>, T: <span class="lifetime">'a</span>&gt; UnsafeFutureObj&lt;<span class="lifetime">'a</span>, T&gt; <span class="kw">for </span>Pin&lt;Box&lt;<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>&gt;&gt; {
<a href=#267 id=267 data-nosnippet>267</a> <span class="kw">fn </span>into_raw(<span class="self">self</span>) -&gt; <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>) {
<a href=#268 id=268 data-nosnippet>268</a> <span class="kw">let </span><span class="kw-2">mut </span>this = mem::ManuallyDrop::new(<span class="self">self</span>);
<a href=#269 id=269 data-nosnippet>269</a> <span class="kw">unsafe </span>{ this.as_mut().get_unchecked_mut() <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_ </span>}
<a href=#270 id=270 data-nosnippet>270</a> }
<a href=#271 id=271 data-nosnippet>271</a>
<a href=#272 id=272 data-nosnippet>272</a> <span class="kw">unsafe fn </span>drop(ptr: <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>)) {
<a href=#273 id=273 data-nosnippet>273</a> drop(Pin::from(<span class="kw">unsafe </span>{ Box::from_raw(ptr) }))
<a href=#274 id=274 data-nosnippet>274</a> }
<a href=#275 id=275 data-nosnippet>275</a> }
<a href=#276 id=276 data-nosnippet>276</a>
<a href=#277 id=277 data-nosnippet>277</a> <span class="kw">unsafe impl</span>&lt;<span class="lifetime">'a</span>, T: <span class="lifetime">'a</span>&gt; UnsafeFutureObj&lt;<span class="lifetime">'a</span>, T&gt; <span class="kw">for </span>Pin&lt;Box&lt;<span class="kw">dyn </span>Future&lt;Output = T&gt; + Send + <span class="lifetime">'a</span>&gt;&gt; {
<a href=#278 id=278 data-nosnippet>278</a> <span class="kw">fn </span>into_raw(<span class="self">self</span>) -&gt; <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>) {
<a href=#279 id=279 data-nosnippet>279</a> <span class="kw">let </span><span class="kw-2">mut </span>this = mem::ManuallyDrop::new(<span class="self">self</span>);
<a href=#280 id=280 data-nosnippet>280</a> <span class="kw">unsafe </span>{ this.as_mut().get_unchecked_mut() <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_ </span>}
<a href=#281 id=281 data-nosnippet>281</a> }
<a href=#282 id=282 data-nosnippet>282</a>
<a href=#283 id=283 data-nosnippet>283</a> <span class="kw">unsafe fn </span>drop(ptr: <span class="kw-2">*mut </span>(<span class="kw">dyn </span>Future&lt;Output = T&gt; + <span class="lifetime">'a</span>)) {
<a href=#284 id=284 data-nosnippet>284</a> drop(Pin::from(<span class="kw">unsafe </span>{ Box::from_raw(ptr) }))
<a href=#285 id=285 data-nosnippet>285</a> }
<a href=#286 id=286 data-nosnippet>286</a> }
<a href=#287 id=287 data-nosnippet>287</a>
<a href=#288 id=288 data-nosnippet>288</a> <span class="kw">impl</span>&lt;<span class="lifetime">'a</span>, F: Future&lt;Output = ()&gt; + Send + <span class="lifetime">'a</span>&gt; From&lt;Box&lt;F&gt;&gt; <span class="kw">for </span>FutureObj&lt;<span class="lifetime">'a</span>, ()&gt; {
<a href=#289 id=289 data-nosnippet>289</a> <span class="kw">fn </span>from(boxed: Box&lt;F&gt;) -&gt; <span class="self">Self </span>{
<a href=#290 id=290 data-nosnippet>290</a> <span class="self">Self</span>::new(boxed)
<a href=#291 id=291 data-nosnippet>291</a> }
<a href=#292 id=292 data-nosnippet>292</a> }
<a href=#293 id=293 data-nosnippet>293</a>
<a href=#294 id=294 data-nosnippet>294</a> <span class="kw">impl</span>&lt;<span class="lifetime">'a</span>&gt; From&lt;Box&lt;<span class="kw">dyn </span>Future&lt;Output = ()&gt; + Send + <span class="lifetime">'a</span>&gt;&gt; <span class="kw">for </span>FutureObj&lt;<span class="lifetime">'a</span>, ()&gt; {
<a href=#295 id=295 data-nosnippet>295</a> <span class="kw">fn </span>from(boxed: Box&lt;<span class="kw">dyn </span>Future&lt;Output = ()&gt; + Send + <span class="lifetime">'a</span>&gt;) -&gt; <span class="self">Self </span>{
<a href=#296 id=296 data-nosnippet>296</a> <span class="self">Self</span>::new(boxed)
<a href=#297 id=297 data-nosnippet>297</a> }
<a href=#298 id=298 data-nosnippet>298</a> }
<a href=#299 id=299 data-nosnippet>299</a>
<a href=#300 id=300 data-nosnippet>300</a> <span class="kw">impl</span>&lt;<span class="lifetime">'a</span>, F: Future&lt;Output = ()&gt; + Send + <span class="lifetime">'a</span>&gt; From&lt;Pin&lt;Box&lt;F&gt;&gt;&gt; <span class="kw">for </span>FutureObj&lt;<span class="lifetime">'a</span>, ()&gt; {
<a href=#301 id=301 data-nosnippet>301</a> <span class="kw">fn </span>from(boxed: Pin&lt;Box&lt;F&gt;&gt;) -&gt; <span class="self">Self </span>{
<a href=#302 id=302 data-nosnippet>302</a> <span class="self">Self</span>::new(boxed)
<a href=#303 id=303 data-nosnippet>303</a> }
<a href=#304 id=304 data-nosnippet>304</a> }
<a href=#305 id=305 data-nosnippet>305</a>
<a href=#306 id=306 data-nosnippet>306</a> <span class="kw">impl</span>&lt;<span class="lifetime">'a</span>&gt; From&lt;Pin&lt;Box&lt;<span class="kw">dyn </span>Future&lt;Output = ()&gt; + Send + <span class="lifetime">'a</span>&gt;&gt;&gt; <span class="kw">for </span>FutureObj&lt;<span class="lifetime">'a</span>, ()&gt; {
<a href=#307 id=307 data-nosnippet>307</a> <span class="kw">fn </span>from(boxed: Pin&lt;Box&lt;<span class="kw">dyn </span>Future&lt;Output = ()&gt; + Send + <span class="lifetime">'a</span>&gt;&gt;) -&gt; <span class="self">Self </span>{
<a href=#308 id=308 data-nosnippet>308</a> <span class="self">Self</span>::new(boxed)
<a href=#309 id=309 data-nosnippet>309</a> }
<a href=#310 id=310 data-nosnippet>310</a> }
<a href=#311 id=311 data-nosnippet>311</a>
<a href=#312 id=312 data-nosnippet>312</a> <span class="kw">impl</span>&lt;<span class="lifetime">'a</span>, F: Future&lt;Output = ()&gt; + <span class="lifetime">'a</span>&gt; From&lt;Box&lt;F&gt;&gt; <span class="kw">for </span>LocalFutureObj&lt;<span class="lifetime">'a</span>, ()&gt; {
<a href=#313 id=313 data-nosnippet>313</a> <span class="kw">fn </span>from(boxed: Box&lt;F&gt;) -&gt; <span class="self">Self </span>{
<a href=#314 id=314 data-nosnippet>314</a> <span class="self">Self</span>::new(boxed)
<a href=#315 id=315 data-nosnippet>315</a> }
<a href=#316 id=316 data-nosnippet>316</a> }
<a href=#317 id=317 data-nosnippet>317</a>
<a href=#318 id=318 data-nosnippet>318</a> <span class="kw">impl</span>&lt;<span class="lifetime">'a</span>&gt; From&lt;Box&lt;<span class="kw">dyn </span>Future&lt;Output = ()&gt; + <span class="lifetime">'a</span>&gt;&gt; <span class="kw">for </span>LocalFutureObj&lt;<span class="lifetime">'a</span>, ()&gt; {
<a href=#319 id=319 data-nosnippet>319</a> <span class="kw">fn </span>from(boxed: Box&lt;<span class="kw">dyn </span>Future&lt;Output = ()&gt; + <span class="lifetime">'a</span>&gt;) -&gt; <span class="self">Self </span>{
<a href=#320 id=320 data-nosnippet>320</a> <span class="self">Self</span>::new(boxed)
<a href=#321 id=321 data-nosnippet>321</a> }
<a href=#322 id=322 data-nosnippet>322</a> }
<a href=#323 id=323 data-nosnippet>323</a>
<a href=#324 id=324 data-nosnippet>324</a> <span class="kw">impl</span>&lt;<span class="lifetime">'a</span>, F: Future&lt;Output = ()&gt; + <span class="lifetime">'a</span>&gt; From&lt;Pin&lt;Box&lt;F&gt;&gt;&gt; <span class="kw">for </span>LocalFutureObj&lt;<span class="lifetime">'a</span>, ()&gt; {
<a href=#325 id=325 data-nosnippet>325</a> <span class="kw">fn </span>from(boxed: Pin&lt;Box&lt;F&gt;&gt;) -&gt; <span class="self">Self </span>{
<a href=#326 id=326 data-nosnippet>326</a> <span class="self">Self</span>::new(boxed)
<a href=#327 id=327 data-nosnippet>327</a> }
<a href=#328 id=328 data-nosnippet>328</a> }
<a href=#329 id=329 data-nosnippet>329</a>
<a href=#330 id=330 data-nosnippet>330</a> <span class="kw">impl</span>&lt;<span class="lifetime">'a</span>&gt; From&lt;Pin&lt;Box&lt;<span class="kw">dyn </span>Future&lt;Output = ()&gt; + <span class="lifetime">'a</span>&gt;&gt;&gt; <span class="kw">for </span>LocalFutureObj&lt;<span class="lifetime">'a</span>, ()&gt; {
<a href=#331 id=331 data-nosnippet>331</a> <span class="kw">fn </span>from(boxed: Pin&lt;Box&lt;<span class="kw">dyn </span>Future&lt;Output = ()&gt; + <span class="lifetime">'a</span>&gt;&gt;) -&gt; <span class="self">Self </span>{
<a href=#332 id=332 data-nosnippet>332</a> <span class="self">Self</span>::new(boxed)
<a href=#333 id=333 data-nosnippet>333</a> }
<a href=#334 id=334 data-nosnippet>334</a> }
<a href=#335 id=335 data-nosnippet>335</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,51 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/futures-task-0.3.32/src/lib.rs`."><title>lib.rs - source</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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">futures_task/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Tools for working with tasks.
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a></span><span class="attr">#![no_std]
<a href=#4 id=4 data-nosnippet>4</a>#![doc(test(
<a href=#5 id=5 data-nosnippet>5</a> no_crate_inject,
<a href=#6 id=6 data-nosnippet>6</a> attr(
<a href=#7 id=7 data-nosnippet>7</a> deny(warnings, rust_2018_idioms, single_use_lifetimes),
<a href=#8 id=8 data-nosnippet>8</a> allow(dead_code, unused_assignments, unused_variables)
<a href=#9 id=9 data-nosnippet>9</a> )
<a href=#10 id=10 data-nosnippet>10</a>))]
<a href=#11 id=11 data-nosnippet>11</a>#![warn(missing_docs, unsafe_op_in_unsafe_fn)]
<a href=#12 id=12 data-nosnippet>12</a>
<a href=#13 id=13 data-nosnippet>13</a>#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#14 id=14 data-nosnippet>14</a></span><span class="kw">extern crate </span>alloc;
<a href=#15 id=15 data-nosnippet>15</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
<a href=#16 id=16 data-nosnippet>16</a></span><span class="kw">extern crate </span>std;
<a href=#17 id=17 data-nosnippet>17</a>
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">mod </span>spawn;
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">pub use </span><span class="kw">crate</span>::spawn::{LocalSpawn, Spawn, SpawnError};
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a><span class="attr">#[cfg_attr(target_os = <span class="string">"none"</span>, cfg(target_has_atomic = <span class="string">"ptr"</span>))]
<a href=#22 id=22 data-nosnippet>22</a>#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#23 id=23 data-nosnippet>23</a></span><span class="kw">mod </span>arc_wake;
<a href=#24 id=24 data-nosnippet>24</a><span class="attr">#[cfg_attr(target_os = <span class="string">"none"</span>, cfg(target_has_atomic = <span class="string">"ptr"</span>))]
<a href=#25 id=25 data-nosnippet>25</a>#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#26 id=26 data-nosnippet>26</a></span><span class="kw">pub use </span><span class="kw">crate</span>::arc_wake::ArcWake;
<a href=#27 id=27 data-nosnippet>27</a>
<a href=#28 id=28 data-nosnippet>28</a><span class="attr">#[cfg_attr(target_os = <span class="string">"none"</span>, cfg(target_has_atomic = <span class="string">"ptr"</span>))]
<a href=#29 id=29 data-nosnippet>29</a>#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#30 id=30 data-nosnippet>30</a></span><span class="kw">mod </span>waker;
<a href=#31 id=31 data-nosnippet>31</a><span class="attr">#[cfg_attr(target_os = <span class="string">"none"</span>, cfg(target_has_atomic = <span class="string">"ptr"</span>))]
<a href=#32 id=32 data-nosnippet>32</a>#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#33 id=33 data-nosnippet>33</a></span><span class="kw">pub use </span><span class="kw">crate</span>::waker::waker;
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a><span class="attr">#[cfg_attr(target_os = <span class="string">"none"</span>, cfg(target_has_atomic = <span class="string">"ptr"</span>))]
<a href=#36 id=36 data-nosnippet>36</a>#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">mod </span>waker_ref;
<a href=#38 id=38 data-nosnippet>38</a><span class="attr">#[cfg_attr(target_os = <span class="string">"none"</span>, cfg(target_has_atomic = <span class="string">"ptr"</span>))]
<a href=#39 id=39 data-nosnippet>39</a>#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#40 id=40 data-nosnippet>40</a></span><span class="kw">pub use </span><span class="kw">crate</span>::waker_ref::{waker_ref, WakerRef};
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a><span class="kw">mod </span>future_obj;
<a href=#43 id=43 data-nosnippet>43</a><span class="kw">pub use </span><span class="kw">crate</span>::future_obj::{FutureObj, LocalFutureObj, UnsafeFutureObj};
<a href=#44 id=44 data-nosnippet>44</a>
<a href=#45 id=45 data-nosnippet>45</a><span class="kw">mod </span>noop_waker;
<a href=#46 id=46 data-nosnippet>46</a><span class="kw">pub use </span><span class="kw">crate</span>::noop_waker::noop_waker;
<a href=#47 id=47 data-nosnippet>47</a><span class="kw">pub use </span><span class="kw">crate</span>::noop_waker::noop_waker_ref;
<a href=#48 id=48 data-nosnippet>48</a>
<a href=#49 id=49 data-nosnippet>49</a><span class="attr">#[doc(no_inline)]
<a href=#50 id=50 data-nosnippet>50</a></span><span class="kw">pub use </span>core::task::{Context, Poll, RawWaker, RawWakerVTable, Waker};
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,64 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/futures-task-0.3.32/src/noop_waker.rs`."><title>noop_waker.rs - source</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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">futures_task/</div>noop_waker.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Utilities for creating zero-cost wakers that don't do anything.
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">use </span>core::ptr::null;
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>core::task::{RawWaker, RawWakerVTable, Waker};
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">unsafe fn </span>noop_clone(_data: <span class="kw-2">*const </span>()) -&gt; RawWaker {
<a href=#7 id=7 data-nosnippet>7</a> noop_raw_waker()
<a href=#8 id=8 data-nosnippet>8</a>}
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">unsafe fn </span>noop(_data: <span class="kw-2">*const </span>()) {}
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">const </span>NOOP_WAKER_VTABLE: RawWakerVTable = RawWakerVTable::new(noop_clone, noop, noop, noop);
<a href=#13 id=13 data-nosnippet>13</a>
<a href=#14 id=14 data-nosnippet>14</a><span class="kw">const fn </span>noop_raw_waker() -&gt; RawWaker {
<a href=#15 id=15 data-nosnippet>15</a> RawWaker::new(null(), <span class="kw-2">&amp;</span>NOOP_WAKER_VTABLE)
<a href=#16 id=16 data-nosnippet>16</a>}
<a href=#17 id=17 data-nosnippet>17</a>
<a href=#18 id=18 data-nosnippet>18</a><span class="doccomment">/// Create a new [`Waker`] which does
<a href=#19 id=19 data-nosnippet>19</a>/// nothing when `wake()` is called on it.
<a href=#20 id=20 data-nosnippet>20</a>///
<a href=#21 id=21 data-nosnippet>21</a>/// # Examples
<a href=#22 id=22 data-nosnippet>22</a>///
<a href=#23 id=23 data-nosnippet>23</a>/// ```
<a href=#24 id=24 data-nosnippet>24</a>/// use futures::task::noop_waker;
<a href=#25 id=25 data-nosnippet>25</a>/// let waker = noop_waker();
<a href=#26 id=26 data-nosnippet>26</a>/// waker.wake();
<a href=#27 id=27 data-nosnippet>27</a>/// ```
<a href=#28 id=28 data-nosnippet>28</a></span><span class="attr">#[inline]
<a href=#29 id=29 data-nosnippet>29</a></span><span class="kw">pub fn </span>noop_waker() -&gt; Waker {
<a href=#30 id=30 data-nosnippet>30</a> <span class="comment">// FIXME: Since 1.46.0 we can use transmute in consts, allowing this function to be const.
<a href=#31 id=31 data-nosnippet>31</a> </span><span class="kw">unsafe </span>{ Waker::from_raw(noop_raw_waker()) }
<a href=#32 id=32 data-nosnippet>32</a>}
<a href=#33 id=33 data-nosnippet>33</a>
<a href=#34 id=34 data-nosnippet>34</a><span class="doccomment">/// Get a static reference to a [`Waker`] which
<a href=#35 id=35 data-nosnippet>35</a>/// does nothing when `wake()` is called on it.
<a href=#36 id=36 data-nosnippet>36</a>///
<a href=#37 id=37 data-nosnippet>37</a>/// # Examples
<a href=#38 id=38 data-nosnippet>38</a>///
<a href=#39 id=39 data-nosnippet>39</a>/// ```
<a href=#40 id=40 data-nosnippet>40</a>/// use futures::task::noop_waker_ref;
<a href=#41 id=41 data-nosnippet>41</a>/// let waker = noop_waker_ref();
<a href=#42 id=42 data-nosnippet>42</a>/// waker.wake_by_ref();
<a href=#43 id=43 data-nosnippet>43</a>/// ```
<a href=#44 id=44 data-nosnippet>44</a></span><span class="attr">#[inline]
<a href=#45 id=45 data-nosnippet>45</a></span><span class="kw">pub fn </span>noop_waker_ref() -&gt; <span class="kw-2">&amp;</span><span class="lifetime">'static </span>Waker {
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw">struct </span>SyncRawWaker(RawWaker);
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">unsafe impl </span>Sync <span class="kw">for </span>SyncRawWaker {}
<a href=#48 id=48 data-nosnippet>48</a>
<a href=#49 id=49 data-nosnippet>49</a> <span class="kw">static </span>NOOP_WAKER_INSTANCE: SyncRawWaker = SyncRawWaker(noop_raw_waker());
<a href=#50 id=50 data-nosnippet>50</a>
<a href=#51 id=51 data-nosnippet>51</a> <span class="comment">// SAFETY: `Waker` is #[repr(transparent)] over its `RawWaker`.
<a href=#52 id=52 data-nosnippet>52</a> </span><span class="kw">unsafe </span>{ <span class="kw-2">&amp;*</span>(<span class="kw-2">&amp;</span>NOOP_WAKER_INSTANCE.<span class="number">0 </span><span class="kw">as </span><span class="kw-2">*const </span>RawWaker <span class="kw">as </span><span class="kw-2">*const </span>Waker) }
<a href=#53 id=53 data-nosnippet>53</a>}
<a href=#54 id=54 data-nosnippet>54</a>
<a href=#55 id=55 data-nosnippet>55</a><span class="attr">#[cfg(test)]
<a href=#56 id=56 data-nosnippet>56</a></span><span class="kw">mod </span>tests {
<a href=#57 id=57 data-nosnippet>57</a> <span class="attr">#[test]
<a href=#58 id=58 data-nosnippet>58</a> #[cfg(feature = <span class="string">"std"</span>)]
<a href=#59 id=59 data-nosnippet>59</a> </span><span class="kw">fn </span>issue_2091_cross_thread_segfault() {
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">let </span>waker = std::thread::spawn(<span class="kw">super</span>::noop_waker_ref).join().unwrap();
<a href=#61 id=61 data-nosnippet>61</a> waker.wake_by_ref();
<a href=#62 id=62 data-nosnippet>62</a> }
<a href=#63 id=63 data-nosnippet>63</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,193 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/futures-task-0.3.32/src/spawn.rs`."><title>spawn.rs - source</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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">futures_task/</div>spawn.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use crate</span>::{FutureObj, LocalFutureObj};
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>core::fmt;
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="doccomment">/// The `Spawn` trait allows for pushing futures onto an executor that will
<a href=#5 id=5 data-nosnippet>5</a>/// run them to completion.
<a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">pub trait </span>Spawn {
<a href=#7 id=7 data-nosnippet>7</a> <span class="doccomment">/// Spawns a future that will be run to completion.
<a href=#8 id=8 data-nosnippet>8</a> ///
<a href=#9 id=9 data-nosnippet>9</a> /// # Errors
<a href=#10 id=10 data-nosnippet>10</a> ///
<a href=#11 id=11 data-nosnippet>11</a> /// The executor may be unable to spawn tasks. Spawn errors should
<a href=#12 id=12 data-nosnippet>12</a> /// represent relatively rare scenarios, such as the executor
<a href=#13 id=13 data-nosnippet>13</a> /// having been shut down so that it is no longer able to accept
<a href=#14 id=14 data-nosnippet>14</a> /// tasks.
<a href=#15 id=15 data-nosnippet>15</a> </span><span class="kw">fn </span>spawn_obj(<span class="kw-2">&amp;</span><span class="self">self</span>, future: FutureObj&lt;<span class="lifetime">'static</span>, ()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt;;
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a> <span class="doccomment">/// Determines whether the executor is able to spawn new tasks.
<a href=#18 id=18 data-nosnippet>18</a> ///
<a href=#19 id=19 data-nosnippet>19</a> /// This method will return `Ok` when the executor is *likely*
<a href=#20 id=20 data-nosnippet>20</a> /// (but not guaranteed) to accept a subsequent spawn attempt.
<a href=#21 id=21 data-nosnippet>21</a> /// Likewise, an `Err` return means that `spawn` is likely, but
<a href=#22 id=22 data-nosnippet>22</a> /// not guaranteed, to yield an error.
<a href=#23 id=23 data-nosnippet>23</a> </span><span class="attr">#[inline]
<a href=#24 id=24 data-nosnippet>24</a> </span><span class="kw">fn </span>status(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#25 id=25 data-nosnippet>25</a> <span class="prelude-val">Ok</span>(())
<a href=#26 id=26 data-nosnippet>26</a> }
<a href=#27 id=27 data-nosnippet>27</a>}
<a href=#28 id=28 data-nosnippet>28</a>
<a href=#29 id=29 data-nosnippet>29</a><span class="doccomment">/// The `LocalSpawn` is similar to [`Spawn`], but allows spawning futures
<a href=#30 id=30 data-nosnippet>30</a>/// that don't implement `Send`.
<a href=#31 id=31 data-nosnippet>31</a></span><span class="kw">pub trait </span>LocalSpawn {
<a href=#32 id=32 data-nosnippet>32</a> <span class="doccomment">/// Spawns a future that will be run to completion.
<a href=#33 id=33 data-nosnippet>33</a> ///
<a href=#34 id=34 data-nosnippet>34</a> /// # Errors
<a href=#35 id=35 data-nosnippet>35</a> ///
<a href=#36 id=36 data-nosnippet>36</a> /// The executor may be unable to spawn tasks. Spawn errors should
<a href=#37 id=37 data-nosnippet>37</a> /// represent relatively rare scenarios, such as the executor
<a href=#38 id=38 data-nosnippet>38</a> /// having been shut down so that it is no longer able to accept
<a href=#39 id=39 data-nosnippet>39</a> /// tasks.
<a href=#40 id=40 data-nosnippet>40</a> </span><span class="kw">fn </span>spawn_local_obj(<span class="kw-2">&amp;</span><span class="self">self</span>, future: LocalFutureObj&lt;<span class="lifetime">'static</span>, ()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt;;
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a> <span class="doccomment">/// Determines whether the executor is able to spawn new tasks.
<a href=#43 id=43 data-nosnippet>43</a> ///
<a href=#44 id=44 data-nosnippet>44</a> /// This method will return `Ok` when the executor is *likely*
<a href=#45 id=45 data-nosnippet>45</a> /// (but not guaranteed) to accept a subsequent spawn attempt.
<a href=#46 id=46 data-nosnippet>46</a> /// Likewise, an `Err` return means that `spawn` is likely, but
<a href=#47 id=47 data-nosnippet>47</a> /// not guaranteed, to yield an error.
<a href=#48 id=48 data-nosnippet>48</a> </span><span class="attr">#[inline]
<a href=#49 id=49 data-nosnippet>49</a> </span><span class="kw">fn </span>status_local(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#50 id=50 data-nosnippet>50</a> <span class="prelude-val">Ok</span>(())
<a href=#51 id=51 data-nosnippet>51</a> }
<a href=#52 id=52 data-nosnippet>52</a>}
<a href=#53 id=53 data-nosnippet>53</a>
<a href=#54 id=54 data-nosnippet>54</a><span class="doccomment">/// An error that occurred during spawning.
<a href=#55 id=55 data-nosnippet>55</a></span><span class="kw">pub struct </span>SpawnError {
<a href=#56 id=56 data-nosnippet>56</a> _priv: (),
<a href=#57 id=57 data-nosnippet>57</a>}
<a href=#58 id=58 data-nosnippet>58</a>
<a href=#59 id=59 data-nosnippet>59</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>SpawnError {
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#61 id=61 data-nosnippet>61</a> f.debug_tuple(<span class="string">"SpawnError"</span>).field(<span class="kw-2">&amp;</span><span class="string">"shutdown"</span>).finish()
<a href=#62 id=62 data-nosnippet>62</a> }
<a href=#63 id=63 data-nosnippet>63</a>}
<a href=#64 id=64 data-nosnippet>64</a>
<a href=#65 id=65 data-nosnippet>65</a><span class="kw">impl </span>fmt::Display <span class="kw">for </span>SpawnError {
<a href=#66 id=66 data-nosnippet>66</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#67 id=67 data-nosnippet>67</a> <span class="macro">write!</span>(f, <span class="string">"Executor is shutdown"</span>)
<a href=#68 id=68 data-nosnippet>68</a> }
<a href=#69 id=69 data-nosnippet>69</a>}
<a href=#70 id=70 data-nosnippet>70</a>
<a href=#71 id=71 data-nosnippet>71</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
<a href=#72 id=72 data-nosnippet>72</a></span><span class="kw">impl </span>std::error::Error <span class="kw">for </span>SpawnError {}
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</a><span class="kw">impl </span>SpawnError {
<a href=#75 id=75 data-nosnippet>75</a> <span class="doccomment">/// Spawning failed because the executor has been shut down.
<a href=#76 id=76 data-nosnippet>76</a> </span><span class="kw">pub fn </span>shutdown() -&gt; <span class="self">Self </span>{
<a href=#77 id=77 data-nosnippet>77</a> <span class="self">Self </span>{ _priv: () }
<a href=#78 id=78 data-nosnippet>78</a> }
<a href=#79 id=79 data-nosnippet>79</a>
<a href=#80 id=80 data-nosnippet>80</a> <span class="doccomment">/// Check whether spawning failed to the executor being shut down.
<a href=#81 id=81 data-nosnippet>81</a> </span><span class="kw">pub fn </span>is_shutdown(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<a href=#82 id=82 data-nosnippet>82</a> <span class="bool-val">true
<a href=#83 id=83 data-nosnippet>83</a> </span>}
<a href=#84 id=84 data-nosnippet>84</a>}
<a href=#85 id=85 data-nosnippet>85</a>
<a href=#86 id=86 data-nosnippet>86</a><span class="kw">impl</span>&lt;Sp: <span class="question-mark">?</span>Sized + Spawn&gt; Spawn <span class="kw">for </span><span class="kw-2">&amp;</span>Sp {
<a href=#87 id=87 data-nosnippet>87</a> <span class="kw">fn </span>spawn_obj(<span class="kw-2">&amp;</span><span class="self">self</span>, future: FutureObj&lt;<span class="lifetime">'static</span>, ()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#88 id=88 data-nosnippet>88</a> Sp::spawn_obj(<span class="self">self</span>, future)
<a href=#89 id=89 data-nosnippet>89</a> }
<a href=#90 id=90 data-nosnippet>90</a>
<a href=#91 id=91 data-nosnippet>91</a> <span class="kw">fn </span>status(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#92 id=92 data-nosnippet>92</a> Sp::status(<span class="self">self</span>)
<a href=#93 id=93 data-nosnippet>93</a> }
<a href=#94 id=94 data-nosnippet>94</a>}
<a href=#95 id=95 data-nosnippet>95</a>
<a href=#96 id=96 data-nosnippet>96</a><span class="kw">impl</span>&lt;Sp: <span class="question-mark">?</span>Sized + Spawn&gt; Spawn <span class="kw">for </span><span class="kw-2">&amp;mut </span>Sp {
<a href=#97 id=97 data-nosnippet>97</a> <span class="kw">fn </span>spawn_obj(<span class="kw-2">&amp;</span><span class="self">self</span>, future: FutureObj&lt;<span class="lifetime">'static</span>, ()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#98 id=98 data-nosnippet>98</a> Sp::spawn_obj(<span class="self">self</span>, future)
<a href=#99 id=99 data-nosnippet>99</a> }
<a href=#100 id=100 data-nosnippet>100</a>
<a href=#101 id=101 data-nosnippet>101</a> <span class="kw">fn </span>status(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#102 id=102 data-nosnippet>102</a> Sp::status(<span class="self">self</span>)
<a href=#103 id=103 data-nosnippet>103</a> }
<a href=#104 id=104 data-nosnippet>104</a>}
<a href=#105 id=105 data-nosnippet>105</a>
<a href=#106 id=106 data-nosnippet>106</a><span class="kw">impl</span>&lt;Sp: <span class="question-mark">?</span>Sized + LocalSpawn&gt; LocalSpawn <span class="kw">for </span><span class="kw-2">&amp;</span>Sp {
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw">fn </span>spawn_local_obj(<span class="kw-2">&amp;</span><span class="self">self</span>, future: LocalFutureObj&lt;<span class="lifetime">'static</span>, ()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#108 id=108 data-nosnippet>108</a> Sp::spawn_local_obj(<span class="self">self</span>, future)
<a href=#109 id=109 data-nosnippet>109</a> }
<a href=#110 id=110 data-nosnippet>110</a>
<a href=#111 id=111 data-nosnippet>111</a> <span class="kw">fn </span>status_local(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#112 id=112 data-nosnippet>112</a> Sp::status_local(<span class="self">self</span>)
<a href=#113 id=113 data-nosnippet>113</a> }
<a href=#114 id=114 data-nosnippet>114</a>}
<a href=#115 id=115 data-nosnippet>115</a>
<a href=#116 id=116 data-nosnippet>116</a><span class="kw">impl</span>&lt;Sp: <span class="question-mark">?</span>Sized + LocalSpawn&gt; LocalSpawn <span class="kw">for </span><span class="kw-2">&amp;mut </span>Sp {
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">fn </span>spawn_local_obj(<span class="kw-2">&amp;</span><span class="self">self</span>, future: LocalFutureObj&lt;<span class="lifetime">'static</span>, ()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#118 id=118 data-nosnippet>118</a> Sp::spawn_local_obj(<span class="self">self</span>, future)
<a href=#119 id=119 data-nosnippet>119</a> }
<a href=#120 id=120 data-nosnippet>120</a>
<a href=#121 id=121 data-nosnippet>121</a> <span class="kw">fn </span>status_local(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#122 id=122 data-nosnippet>122</a> Sp::status_local(<span class="self">self</span>)
<a href=#123 id=123 data-nosnippet>123</a> }
<a href=#124 id=124 data-nosnippet>124</a>}
<a href=#125 id=125 data-nosnippet>125</a>
<a href=#126 id=126 data-nosnippet>126</a><span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#127 id=127 data-nosnippet>127</a></span><span class="kw">mod </span>if_alloc {
<a href=#128 id=128 data-nosnippet>128</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#129 id=129 data-nosnippet>129</a> <span class="kw">use </span>alloc::{boxed::Box, rc::Rc};
<a href=#130 id=130 data-nosnippet>130</a>
<a href=#131 id=131 data-nosnippet>131</a> <span class="kw">impl</span>&lt;Sp: <span class="question-mark">?</span>Sized + Spawn&gt; Spawn <span class="kw">for </span>Box&lt;Sp&gt; {
<a href=#132 id=132 data-nosnippet>132</a> <span class="kw">fn </span>spawn_obj(<span class="kw-2">&amp;</span><span class="self">self</span>, future: FutureObj&lt;<span class="lifetime">'static</span>, ()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#133 id=133 data-nosnippet>133</a> (<span class="kw-2">**</span><span class="self">self</span>).spawn_obj(future)
<a href=#134 id=134 data-nosnippet>134</a> }
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a> <span class="kw">fn </span>status(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#137 id=137 data-nosnippet>137</a> (<span class="kw-2">**</span><span class="self">self</span>).status()
<a href=#138 id=138 data-nosnippet>138</a> }
<a href=#139 id=139 data-nosnippet>139</a> }
<a href=#140 id=140 data-nosnippet>140</a>
<a href=#141 id=141 data-nosnippet>141</a> <span class="kw">impl</span>&lt;Sp: <span class="question-mark">?</span>Sized + LocalSpawn&gt; LocalSpawn <span class="kw">for </span>Box&lt;Sp&gt; {
<a href=#142 id=142 data-nosnippet>142</a> <span class="kw">fn </span>spawn_local_obj(<span class="kw-2">&amp;</span><span class="self">self</span>, future: LocalFutureObj&lt;<span class="lifetime">'static</span>, ()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#143 id=143 data-nosnippet>143</a> (<span class="kw-2">**</span><span class="self">self</span>).spawn_local_obj(future)
<a href=#144 id=144 data-nosnippet>144</a> }
<a href=#145 id=145 data-nosnippet>145</a>
<a href=#146 id=146 data-nosnippet>146</a> <span class="kw">fn </span>status_local(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#147 id=147 data-nosnippet>147</a> (<span class="kw-2">**</span><span class="self">self</span>).status_local()
<a href=#148 id=148 data-nosnippet>148</a> }
<a href=#149 id=149 data-nosnippet>149</a> }
<a href=#150 id=150 data-nosnippet>150</a>
<a href=#151 id=151 data-nosnippet>151</a> <span class="kw">impl</span>&lt;Sp: <span class="question-mark">?</span>Sized + Spawn&gt; Spawn <span class="kw">for </span>Rc&lt;Sp&gt; {
<a href=#152 id=152 data-nosnippet>152</a> <span class="kw">fn </span>spawn_obj(<span class="kw-2">&amp;</span><span class="self">self</span>, future: FutureObj&lt;<span class="lifetime">'static</span>, ()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#153 id=153 data-nosnippet>153</a> (<span class="kw-2">**</span><span class="self">self</span>).spawn_obj(future)
<a href=#154 id=154 data-nosnippet>154</a> }
<a href=#155 id=155 data-nosnippet>155</a>
<a href=#156 id=156 data-nosnippet>156</a> <span class="kw">fn </span>status(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#157 id=157 data-nosnippet>157</a> (<span class="kw-2">**</span><span class="self">self</span>).status()
<a href=#158 id=158 data-nosnippet>158</a> }
<a href=#159 id=159 data-nosnippet>159</a> }
<a href=#160 id=160 data-nosnippet>160</a>
<a href=#161 id=161 data-nosnippet>161</a> <span class="kw">impl</span>&lt;Sp: <span class="question-mark">?</span>Sized + LocalSpawn&gt; LocalSpawn <span class="kw">for </span>Rc&lt;Sp&gt; {
<a href=#162 id=162 data-nosnippet>162</a> <span class="kw">fn </span>spawn_local_obj(<span class="kw-2">&amp;</span><span class="self">self</span>, future: LocalFutureObj&lt;<span class="lifetime">'static</span>, ()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#163 id=163 data-nosnippet>163</a> (<span class="kw-2">**</span><span class="self">self</span>).spawn_local_obj(future)
<a href=#164 id=164 data-nosnippet>164</a> }
<a href=#165 id=165 data-nosnippet>165</a>
<a href=#166 id=166 data-nosnippet>166</a> <span class="kw">fn </span>status_local(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#167 id=167 data-nosnippet>167</a> (<span class="kw-2">**</span><span class="self">self</span>).status_local()
<a href=#168 id=168 data-nosnippet>168</a> }
<a href=#169 id=169 data-nosnippet>169</a> }
<a href=#170 id=170 data-nosnippet>170</a>
<a href=#171 id=171 data-nosnippet>171</a> <span class="attr">#[cfg_attr(target_os = <span class="string">"none"</span>, cfg(target_has_atomic = <span class="string">"ptr"</span>))]
<a href=#172 id=172 data-nosnippet>172</a> </span><span class="kw">impl</span>&lt;Sp: <span class="question-mark">?</span>Sized + Spawn&gt; Spawn <span class="kw">for </span>alloc::sync::Arc&lt;Sp&gt; {
<a href=#173 id=173 data-nosnippet>173</a> <span class="kw">fn </span>spawn_obj(<span class="kw-2">&amp;</span><span class="self">self</span>, future: FutureObj&lt;<span class="lifetime">'static</span>, ()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#174 id=174 data-nosnippet>174</a> (<span class="kw-2">**</span><span class="self">self</span>).spawn_obj(future)
<a href=#175 id=175 data-nosnippet>175</a> }
<a href=#176 id=176 data-nosnippet>176</a>
<a href=#177 id=177 data-nosnippet>177</a> <span class="kw">fn </span>status(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#178 id=178 data-nosnippet>178</a> (<span class="kw-2">**</span><span class="self">self</span>).status()
<a href=#179 id=179 data-nosnippet>179</a> }
<a href=#180 id=180 data-nosnippet>180</a> }
<a href=#181 id=181 data-nosnippet>181</a>
<a href=#182 id=182 data-nosnippet>182</a> <span class="attr">#[cfg_attr(target_os = <span class="string">"none"</span>, cfg(target_has_atomic = <span class="string">"ptr"</span>))]
<a href=#183 id=183 data-nosnippet>183</a> </span><span class="kw">impl</span>&lt;Sp: <span class="question-mark">?</span>Sized + LocalSpawn&gt; LocalSpawn <span class="kw">for </span>alloc::sync::Arc&lt;Sp&gt; {
<a href=#184 id=184 data-nosnippet>184</a> <span class="kw">fn </span>spawn_local_obj(<span class="kw-2">&amp;</span><span class="self">self</span>, future: LocalFutureObj&lt;<span class="lifetime">'static</span>, ()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#185 id=185 data-nosnippet>185</a> (<span class="kw-2">**</span><span class="self">self</span>).spawn_local_obj(future)
<a href=#186 id=186 data-nosnippet>186</a> }
<a href=#187 id=187 data-nosnippet>187</a>
<a href=#188 id=188 data-nosnippet>188</a> <span class="kw">fn </span>status_local(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<a href=#189 id=189 data-nosnippet>189</a> (<span class="kw-2">**</span><span class="self">self</span>).status_local()
<a href=#190 id=190 data-nosnippet>190</a> }
<a href=#191 id=191 data-nosnippet>191</a> }
<a href=#192 id=192 data-nosnippet>192</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,61 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/futures-task-0.3.32/src/waker.rs`."><title>waker.rs - source</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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">futures_task/</div>waker.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span><span class="kw">super</span>::arc_wake::ArcWake;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>alloc::sync::Arc;
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>core::mem;
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>core::task::{RawWaker, RawWakerVTable, Waker};
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>waker_vtable&lt;W: ArcWake + <span class="lifetime">'static</span>&gt;() -&gt; <span class="kw-2">&amp;</span><span class="lifetime">'static </span>RawWakerVTable {
<a href=#7 id=7 data-nosnippet>7</a> <span class="kw-2">&amp;</span>RawWakerVTable::new(
<a href=#8 id=8 data-nosnippet>8</a> clone_arc_raw::&lt;W&gt;,
<a href=#9 id=9 data-nosnippet>9</a> wake_arc_raw::&lt;W&gt;,
<a href=#10 id=10 data-nosnippet>10</a> wake_by_ref_arc_raw::&lt;W&gt;,
<a href=#11 id=11 data-nosnippet>11</a> drop_arc_raw::&lt;W&gt;,
<a href=#12 id=12 data-nosnippet>12</a> )
<a href=#13 id=13 data-nosnippet>13</a>}
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a><span class="doccomment">/// Creates a [`Waker`] from an `Arc&lt;impl ArcWake&gt;`.
<a href=#16 id=16 data-nosnippet>16</a>///
<a href=#17 id=17 data-nosnippet>17</a>/// The returned [`Waker`] will call
<a href=#18 id=18 data-nosnippet>18</a>/// [`ArcWake.wake()`](ArcWake::wake) if awoken.
<a href=#19 id=19 data-nosnippet>19</a></span><span class="kw">pub fn </span>waker&lt;W&gt;(wake: Arc&lt;W&gt;) -&gt; Waker
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">where
<a href=#21 id=21 data-nosnippet>21</a> </span>W: ArcWake + <span class="lifetime">'static</span>,
<a href=#22 id=22 data-nosnippet>22</a>{
<a href=#23 id=23 data-nosnippet>23</a> <span class="kw">let </span>ptr = Arc::into_raw(wake).cast::&lt;()&gt;();
<a href=#24 id=24 data-nosnippet>24</a>
<a href=#25 id=25 data-nosnippet>25</a> <span class="kw">unsafe </span>{ Waker::from_raw(RawWaker::new(ptr, waker_vtable::&lt;W&gt;())) }
<a href=#26 id=26 data-nosnippet>26</a>}
<a href=#27 id=27 data-nosnippet>27</a>
<a href=#28 id=28 data-nosnippet>28</a><span class="comment">// FIXME: panics on Arc::clone / refcount changes could wreak havoc on the
<a href=#29 id=29 data-nosnippet>29</a>// code here. We should guard against this by aborting.
<a href=#30 id=30 data-nosnippet>30</a>
<a href=#31 id=31 data-nosnippet>31</a></span><span class="attr">#[allow(clippy::redundant_clone)] </span><span class="comment">// The clone here isn't actually redundant.
<a href=#32 id=32 data-nosnippet>32</a></span><span class="kw">unsafe fn </span>increase_refcount&lt;T: ArcWake + <span class="lifetime">'static</span>&gt;(data: <span class="kw-2">*const </span>()) {
<a href=#33 id=33 data-nosnippet>33</a> <span class="comment">// Retain Arc, but don't touch refcount by wrapping in ManuallyDrop
<a href=#34 id=34 data-nosnippet>34</a> </span><span class="kw">let </span>arc = mem::ManuallyDrop::new(<span class="kw">unsafe </span>{ Arc::&lt;T&gt;::from_raw(data.cast::&lt;T&gt;()) });
<a href=#35 id=35 data-nosnippet>35</a> <span class="comment">// Now increase refcount, but don't drop new refcount either
<a href=#36 id=36 data-nosnippet>36</a> </span><span class="kw">let </span>_arc_clone: mem::ManuallyDrop&lt;<span class="kw">_</span>&gt; = arc.clone();
<a href=#37 id=37 data-nosnippet>37</a>}
<a href=#38 id=38 data-nosnippet>38</a>
<a href=#39 id=39 data-nosnippet>39</a><span class="comment">// used by `waker_ref`
<a href=#40 id=40 data-nosnippet>40</a></span><span class="attr">#[inline(always)]
<a href=#41 id=41 data-nosnippet>41</a></span><span class="kw">unsafe fn </span>clone_arc_raw&lt;T: ArcWake + <span class="lifetime">'static</span>&gt;(data: <span class="kw-2">*const </span>()) -&gt; RawWaker {
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw">unsafe </span>{ increase_refcount::&lt;T&gt;(data) }
<a href=#43 id=43 data-nosnippet>43</a> RawWaker::new(data, waker_vtable::&lt;T&gt;())
<a href=#44 id=44 data-nosnippet>44</a>}
<a href=#45 id=45 data-nosnippet>45</a>
<a href=#46 id=46 data-nosnippet>46</a><span class="kw">unsafe fn </span>wake_arc_raw&lt;T: ArcWake + <span class="lifetime">'static</span>&gt;(data: <span class="kw-2">*const </span>()) {
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">let </span>arc: Arc&lt;T&gt; = <span class="kw">unsafe </span>{ Arc::from_raw(data.cast::&lt;T&gt;()) };
<a href=#48 id=48 data-nosnippet>48</a> ArcWake::wake(arc);
<a href=#49 id=49 data-nosnippet>49</a>}
<a href=#50 id=50 data-nosnippet>50</a>
<a href=#51 id=51 data-nosnippet>51</a><span class="comment">// used by `waker_ref`
<a href=#52 id=52 data-nosnippet>52</a></span><span class="kw">unsafe fn </span>wake_by_ref_arc_raw&lt;T: ArcWake + <span class="lifetime">'static</span>&gt;(data: <span class="kw-2">*const </span>()) {
<a href=#53 id=53 data-nosnippet>53</a> <span class="comment">// Retain Arc, but don't touch refcount by wrapping in ManuallyDrop
<a href=#54 id=54 data-nosnippet>54</a> </span><span class="kw">let </span>arc = mem::ManuallyDrop::new(<span class="kw">unsafe </span>{ Arc::&lt;T&gt;::from_raw(data.cast::&lt;T&gt;()) });
<a href=#55 id=55 data-nosnippet>55</a> ArcWake::wake_by_ref(<span class="kw-2">&amp;</span>arc);
<a href=#56 id=56 data-nosnippet>56</a>}
<a href=#57 id=57 data-nosnippet>57</a>
<a href=#58 id=58 data-nosnippet>58</a><span class="kw">unsafe fn </span>drop_arc_raw&lt;T: ArcWake + <span class="lifetime">'static</span>&gt;(data: <span class="kw-2">*const </span>()) {
<a href=#59 id=59 data-nosnippet>59</a> drop(<span class="kw">unsafe </span>{ Arc::&lt;T&gt;::from_raw(data.cast::&lt;T&gt;()) })
<a href=#60 id=60 data-nosnippet>60</a>}
</code></pre></div></section></main></body></html>

View File

@@ -0,0 +1,67 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/futures-task-0.3.32/src/waker_ref.rs`."><title>waker_ref.rs - source</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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">futures_task/</div>waker_ref.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span><span class="kw">super</span>::arc_wake::ArcWake;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span><span class="kw">super</span>::waker::waker_vtable;
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>alloc::sync::Arc;
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>core::marker::PhantomData;
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>core::mem::ManuallyDrop;
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">use </span>core::ops::Deref;
<a href=#7 id=7 data-nosnippet>7</a><span class="kw">use </span>core::task::{RawWaker, Waker};
<a href=#8 id=8 data-nosnippet>8</a>
<a href=#9 id=9 data-nosnippet>9</a><span class="doccomment">/// A [`Waker`] that is only valid for a given lifetime.
<a href=#10 id=10 data-nosnippet>10</a>///
<a href=#11 id=11 data-nosnippet>11</a>/// Note: this type implements [`Deref&lt;Target = Waker&gt;`](std::ops::Deref),
<a href=#12 id=12 data-nosnippet>12</a>/// so it can be used to get a `&amp;Waker`.
<a href=#13 id=13 data-nosnippet>13</a></span><span class="attr">#[derive(Debug)]
<a href=#14 id=14 data-nosnippet>14</a></span><span class="kw">pub struct </span>WakerRef&lt;<span class="lifetime">'a</span>&gt; {
<a href=#15 id=15 data-nosnippet>15</a> waker: ManuallyDrop&lt;Waker&gt;,
<a href=#16 id=16 data-nosnippet>16</a> _marker: PhantomData&lt;<span class="kw-2">&amp;</span><span class="lifetime">'a </span>()&gt;,
<a href=#17 id=17 data-nosnippet>17</a>}
<a href=#18 id=18 data-nosnippet>18</a>
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">impl</span>&lt;<span class="lifetime">'a</span>&gt; WakerRef&lt;<span class="lifetime">'a</span>&gt; {
<a href=#20 id=20 data-nosnippet>20</a> <span class="doccomment">/// Create a new [`WakerRef`] from a [`Waker`] reference.
<a href=#21 id=21 data-nosnippet>21</a> </span><span class="attr">#[inline]
<a href=#22 id=22 data-nosnippet>22</a> </span><span class="kw">pub fn </span>new(waker: <span class="kw-2">&amp;</span><span class="lifetime">'a </span>Waker) -&gt; <span class="self">Self </span>{
<a href=#23 id=23 data-nosnippet>23</a> <span class="comment">// copy the underlying (raw) waker without calling a clone,
<a href=#24 id=24 data-nosnippet>24</a> // as we won't call Waker::drop either.
<a href=#25 id=25 data-nosnippet>25</a> </span><span class="kw">let </span>waker = ManuallyDrop::new(<span class="kw">unsafe </span>{ core::ptr::read(waker) });
<a href=#26 id=26 data-nosnippet>26</a> <span class="self">Self </span>{ waker, _marker: PhantomData }
<a href=#27 id=27 data-nosnippet>27</a> }
<a href=#28 id=28 data-nosnippet>28</a>
<a href=#29 id=29 data-nosnippet>29</a> <span class="doccomment">/// Create a new [`WakerRef`] from a [`Waker`] that must not be dropped.
<a href=#30 id=30 data-nosnippet>30</a> ///
<a href=#31 id=31 data-nosnippet>31</a> /// Note: this if for rare cases where the caller created a [`Waker`] in
<a href=#32 id=32 data-nosnippet>32</a> /// an unsafe way (that will be valid only for a lifetime to be determined
<a href=#33 id=33 data-nosnippet>33</a> /// by the caller), and the [`Waker`] doesn't need to or must not be
<a href=#34 id=34 data-nosnippet>34</a> /// destroyed.
<a href=#35 id=35 data-nosnippet>35</a> </span><span class="attr">#[inline]
<a href=#36 id=36 data-nosnippet>36</a> </span><span class="kw">pub fn </span>new_unowned(waker: ManuallyDrop&lt;Waker&gt;) -&gt; <span class="self">Self </span>{
<a href=#37 id=37 data-nosnippet>37</a> <span class="self">Self </span>{ waker, _marker: PhantomData }
<a href=#38 id=38 data-nosnippet>38</a> }
<a href=#39 id=39 data-nosnippet>39</a>}
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a><span class="kw">impl </span>Deref <span class="kw">for </span>WakerRef&lt;<span class="lifetime">'_</span>&gt; {
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw">type </span>Target = Waker;
<a href=#43 id=43 data-nosnippet>43</a>
<a href=#44 id=44 data-nosnippet>44</a> <span class="attr">#[inline]
<a href=#45 id=45 data-nosnippet>45</a> </span><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 {
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw-2">&amp;</span><span class="self">self</span>.waker
<a href=#47 id=47 data-nosnippet>47</a> }
<a href=#48 id=48 data-nosnippet>48</a>}
<a href=#49 id=49 data-nosnippet>49</a>
<a href=#50 id=50 data-nosnippet>50</a><span class="doccomment">/// Creates a reference to a [`Waker`] from a reference to `Arc&lt;impl ArcWake&gt;`.
<a href=#51 id=51 data-nosnippet>51</a>///
<a href=#52 id=52 data-nosnippet>52</a>/// The resulting [`Waker`] will call
<a href=#53 id=53 data-nosnippet>53</a>/// [`ArcWake.wake()`](ArcWake::wake) if awoken.
<a href=#54 id=54 data-nosnippet>54</a></span><span class="attr">#[inline]
<a href=#55 id=55 data-nosnippet>55</a></span><span class="kw">pub fn </span>waker_ref&lt;W&gt;(wake: <span class="kw-2">&amp;</span>Arc&lt;W&gt;) -&gt; WakerRef&lt;<span class="lifetime">'_</span>&gt;
<a href=#56 id=56 data-nosnippet>56</a><span class="kw">where
<a href=#57 id=57 data-nosnippet>57</a> </span>W: ArcWake + <span class="lifetime">'static</span>,
<a href=#58 id=58 data-nosnippet>58</a>{
<a href=#59 id=59 data-nosnippet>59</a> <span class="comment">// simply copy the pointer instead of using Arc::into_raw,
<a href=#60 id=60 data-nosnippet>60</a> // as we don't actually keep a refcount by using ManuallyDrop.&lt;
<a href=#61 id=61 data-nosnippet>61</a> </span><span class="kw">let </span>ptr = Arc::as_ptr(wake).cast::&lt;()&gt;();
<a href=#62 id=62 data-nosnippet>62</a>
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">let </span>waker =
<a href=#64 id=64 data-nosnippet>64</a> ManuallyDrop::new(<span class="kw">unsafe </span>{ Waker::from_raw(RawWaker::new(ptr, waker_vtable::&lt;W&gt;())) });
<a href=#65 id=65 data-nosnippet>65</a> WakerRef::new_unowned(waker)
<a href=#66 id=66 data-nosnippet>66</a>}
</code></pre></div></section></main></body></html>