<!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 `src\async\tasks.rs`."><title>tasks.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"><script id="default-settings"
data-use_system_theme="false"
data-theme="trash"></script><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="trash_utilities" data-themes="trash" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (b925a865e 2025-10-09)" data-channel="nightly" data-search-js="search-8d3311b9.js" data-stringdex-js="stringdex-828709d0.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-ce535bd0.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">trash_utilities\async/</div>tasks.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="doccomment">/// Task management utilities for spawning and coordinating async tasks.
<a href=#2 id=2 data-nosnippet>2</a>///
<a href=#3 id=3 data-nosnippet>3</a>/// This module provides task spawners and groups for managing concurrent async operations,
<a href=#4 id=4 data-nosnippet>4</a>/// with built-in cancellation support and error handling using smol runtime.
<a href=#5 id=5 data-nosnippet>5</a></span><span class="comment">// Standard library imports
<a href=#6 id=6 data-nosnippet>6</a>// External crate imports
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">use </span>parking_lot::Mutex;
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">use </span>smol;
<a href=#9 id=9 data-nosnippet>9</a><span class="kw">use </span>smol_cancellation_token::CancellationToken;
<a href=#10 id=10 data-nosnippet>10</a>
<a href=#11 id=11 data-nosnippet>11</a><span class="doccomment">/// Async task spawner with error handling
<a href=#12 id=12 data-nosnippet>12</a></span><span class="kw">pub struct </span>AsyncTaskSpawner {
<a href=#13 id=13 data-nosnippet>13</a> token: CancellationToken,
<a href=#14 id=14 data-nosnippet>14</a> handles: Mutex<Vec<smol::Task<()>>>,
<a href=#15 id=15 data-nosnippet>15</a>}
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">impl </span>AsyncTaskSpawner {
<a href=#18 id=18 data-nosnippet>18</a> <span class="doccomment">/// Create a new task spawner
<a href=#19 id=19 data-nosnippet>19</a> </span><span class="attr">#[must_use]
<a href=#20 id=20 data-nosnippet>20</a> </span><span class="kw">pub fn </span>new() -> <span class="self">Self </span>{
<a href=#21 id=21 data-nosnippet>21</a> <span class="self">Self </span>{
<a href=#22 id=22 data-nosnippet>22</a> token: CancellationToken::new(),
<a href=#23 id=23 data-nosnippet>23</a> handles: Mutex::new(Vec::new()),
<a href=#24 id=24 data-nosnippet>24</a> }
<a href=#25 id=25 data-nosnippet>25</a> }
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a> <span class="doccomment">/// Create a builder for more complex configuration
<a href=#28 id=28 data-nosnippet>28</a> </span><span class="attr">#[must_use]
<a href=#29 id=29 data-nosnippet>29</a> </span><span class="kw">pub fn </span>builder() -> AsyncTaskSpawnerBuilder {
<a href=#30 id=30 data-nosnippet>30</a> AsyncTaskSpawnerBuilder::new()
<a href=#31 id=31 data-nosnippet>31</a> }
<a href=#32 id=32 data-nosnippet>32</a>
<a href=#33 id=33 data-nosnippet>33</a> <span class="doccomment">/// Spawn an async task (non-blocking)
<a href=#34 id=34 data-nosnippet>34</a> </span><span class="kw">pub fn </span>spawn<F, Fut>(<span class="kw-2">&</span><span class="self">self</span>, task: F)
<a href=#35 id=35 data-nosnippet>35</a> <span class="kw">where
<a href=#36 id=36 data-nosnippet>36</a> </span>F: FnOnce() -> Fut + Send + <span class="lifetime">'static</span>,
<a href=#37 id=37 data-nosnippet>37</a> Fut: std::future::Future<Output = ()> + Send + <span class="lifetime">'static</span>,
<a href=#38 id=38 data-nosnippet>38</a> {
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw">let </span>token = <span class="self">self</span>.token.clone();
<a href=#40 id=40 data-nosnippet>40</a> <span class="kw">let </span>handle = smol::spawn(<span class="kw">async move </span>{
<a href=#41 id=41 data-nosnippet>41</a> <span class="kw">if </span>!token.is_cancelled() {
<a href=#42 id=42 data-nosnippet>42</a> task().<span class="kw">await</span>;
<a href=#43 id=43 data-nosnippet>43</a> }
<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="self">self</span>.handles.lock().push(handle);
<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> <span class="doccomment">/// Cancel all tasks
<a href=#50 id=50 data-nosnippet>50</a> </span><span class="kw">pub fn </span>cancel(<span class="kw-2">&</span><span class="self">self</span>) {
<a href=#51 id=51 data-nosnippet>51</a> <span class="self">self</span>.token.cancel();
<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">/// Wait for all tasks to complete (non-blocking)
<a href=#55 id=55 data-nosnippet>55</a> </span><span class="kw">pub async fn </span>wait_all(<span class="kw-2">&</span><span class="self">self</span>) {
<a href=#56 id=56 data-nosnippet>56</a> <span class="kw">let </span>handles = std::mem::take(<span class="kw-2">&mut *</span><span class="self">self</span>.handles.lock());
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw">for </span>handle <span class="kw">in </span>handles {
<a href=#58 id=58 data-nosnippet>58</a> <span class="kw">let </span>() = handle.<span class="kw">await</span>;
<a href=#59 id=59 data-nosnippet>59</a> }
<a href=#60 id=60 data-nosnippet>60</a> }
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a> <span class="doccomment">/// Chain method to spawn a task (consumes self)
<a href=#63 id=63 data-nosnippet>63</a> </span><span class="attr">#[must_use]
<a href=#64 id=64 data-nosnippet>64</a> </span><span class="kw">pub fn </span>with_task<F, Fut>(<span class="self">self</span>, task: F) -> <span class="self">Self
<a href=#65 id=65 data-nosnippet>65</a> </span><span class="kw">where
<a href=#66 id=66 data-nosnippet>66</a> </span>F: FnOnce() -> Fut + Send + <span class="lifetime">'static</span>,
<a href=#67 id=67 data-nosnippet>67</a> Fut: std::future::Future<Output = ()> + Send + <span class="lifetime">'static</span>,
<a href=#68 id=68 data-nosnippet>68</a> {
<a href=#69 id=69 data-nosnippet>69</a> <span class="self">self</span>.spawn(task);
<a href=#70 id=70 data-nosnippet>70</a> <span class="self">self
<a href=#71 id=71 data-nosnippet>71</a> </span>}
<a href=#72 id=72 data-nosnippet>72</a>
<a href=#73 id=73 data-nosnippet>73</a> <span class="doccomment">/// Chain method to cancel tasks (consumes self)
<a href=#74 id=74 data-nosnippet>74</a> </span><span class="attr">#[must_use]
<a href=#75 id=75 data-nosnippet>75</a> </span><span class="kw">pub fn </span>with_cancel(<span class="self">self</span>) -> <span class="self">Self </span>{
<a href=#76 id=76 data-nosnippet>76</a> <span class="self">self</span>.cancel();
<a href=#77 id=77 data-nosnippet>77</a> <span class="self">self
<a href=#78 id=78 data-nosnippet>78</a> </span>}
<a href=#79 id=79 data-nosnippet>79</a>}
<a href=#80 id=80 data-nosnippet>80</a>
<a href=#81 id=81 data-nosnippet>81</a><span class="kw">impl </span>Default <span class="kw">for </span>AsyncTaskSpawner {
<a href=#82 id=82 data-nosnippet>82</a> <span class="kw">fn </span>default() -> <span class="self">Self </span>{
<a href=#83 id=83 data-nosnippet>83</a> <span class="self">Self</span>::new()
<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>
<a href=#87 id=87 data-nosnippet>87</a><span class="doccomment">/// Builder for `AsyncTaskSpawner` with ergonomic configuration
<a href=#88 id=88 data-nosnippet>88</a></span><span class="kw">pub struct </span>AsyncTaskSpawnerBuilder {
<a href=#89 id=89 data-nosnippet>89</a> token: <span class="prelude-ty">Option</span><CancellationToken>,
<a href=#90 id=90 data-nosnippet>90</a>}
<a href=#91 id=91 data-nosnippet>91</a>
<a href=#92 id=92 data-nosnippet>92</a><span class="kw">impl </span>AsyncTaskSpawnerBuilder {
<a href=#93 id=93 data-nosnippet>93</a> <span class="doccomment">/// Create a new builder
<a href=#94 id=94 data-nosnippet>94</a> </span><span class="attr">#[must_use]
<a href=#95 id=95 data-nosnippet>95</a> </span><span class="kw">pub fn </span>new() -> <span class="self">Self </span>{
<a href=#96 id=96 data-nosnippet>96</a> <span class="self">Self </span>{ token: <span class="prelude-val">None </span>}
<a href=#97 id=97 data-nosnippet>97</a> }
<a href=#98 id=98 data-nosnippet>98</a>
<a href=#99 id=99 data-nosnippet>99</a> <span class="doccomment">/// Set a custom cancellation token
<a href=#100 id=100 data-nosnippet>100</a> </span><span class="attr">#[must_use]
<a href=#101 id=101 data-nosnippet>101</a> </span><span class="kw">pub fn </span>with_cancellation_token(<span class="kw-2">mut </span><span class="self">self</span>, token: CancellationToken) -> <span class="self">Self </span>{
<a href=#102 id=102 data-nosnippet>102</a> <span class="self">self</span>.token = <span class="prelude-val">Some</span>(token);
<a href=#103 id=103 data-nosnippet>103</a> <span class="self">self
<a href=#104 id=104 data-nosnippet>104</a> </span>}
<a href=#105 id=105 data-nosnippet>105</a>
<a href=#106 id=106 data-nosnippet>106</a> <span class="doccomment">/// Build the `AsyncTaskSpawner`
<a href=#107 id=107 data-nosnippet>107</a> </span><span class="attr">#[must_use]
<a href=#108 id=108 data-nosnippet>108</a> </span><span class="kw">pub fn </span>build(<span class="self">self</span>) -> AsyncTaskSpawner {
<a href=#109 id=109 data-nosnippet>109</a> AsyncTaskSpawner {
<a href=#110 id=110 data-nosnippet>110</a> token: <span class="self">self</span>.token.unwrap_or_default(),
<a href=#111 id=111 data-nosnippet>111</a> handles: Mutex::new(Vec::new()),
<a href=#112 id=112 data-nosnippet>112</a> }
<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>Default <span class="kw">for </span>AsyncTaskSpawnerBuilder {
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">fn </span>default() -> <span class="self">Self </span>{
<a href=#118 id=118 data-nosnippet>118</a> <span class="self">Self</span>::new()
<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="doccomment">/// Async task group for managing multiple related tasks (non-blocking)
<a href=#123 id=123 data-nosnippet>123</a></span><span class="kw">pub struct </span>AsyncTaskGroup {
<a href=#124 id=124 data-nosnippet>124</a> token: CancellationToken,
<a href=#125 id=125 data-nosnippet>125</a> tasks: Mutex<Vec<smol::Task<()>>>,
<a href=#126 id=126 data-nosnippet>126</a>}
<a href=#127 id=127 data-nosnippet>127</a>
<a href=#128 id=128 data-nosnippet>128</a><span class="kw">impl </span>AsyncTaskGroup {
<a href=#129 id=129 data-nosnippet>129</a> <span class="doccomment">/// Create a new task group
<a href=#130 id=130 data-nosnippet>130</a> </span><span class="attr">#[must_use]
<a href=#131 id=131 data-nosnippet>131</a> </span><span class="kw">pub fn </span>new() -> <span class="self">Self </span>{
<a href=#132 id=132 data-nosnippet>132</a> <span class="self">Self </span>{
<a href=#133 id=133 data-nosnippet>133</a> token: CancellationToken::new(),
<a href=#134 id=134 data-nosnippet>134</a> tasks: Mutex::new(Vec::new()),
<a href=#135 id=135 data-nosnippet>135</a> }
<a href=#136 id=136 data-nosnippet>136</a> }
<a href=#137 id=137 data-nosnippet>137</a>
<a href=#138 id=138 data-nosnippet>138</a> <span class="doccomment">/// Add a task to the group (non-blocking)
<a href=#139 id=139 data-nosnippet>139</a> </span><span class="kw">pub fn </span>add_task<F, Fut>(<span class="kw-2">&</span><span class="self">self</span>, task: F)
<a href=#140 id=140 data-nosnippet>140</a> <span class="kw">where
<a href=#141 id=141 data-nosnippet>141</a> </span>F: FnOnce() -> Fut + Send + <span class="lifetime">'static</span>,
<a href=#142 id=142 data-nosnippet>142</a> Fut: std::future::Future<Output = ()> + Send + <span class="lifetime">'static</span>,
<a href=#143 id=143 data-nosnippet>143</a> {
<a href=#144 id=144 data-nosnippet>144</a> <span class="kw">let </span>token = <span class="self">self</span>.token.clone();
<a href=#145 id=145 data-nosnippet>145</a> <span class="kw">let </span>task_handle = smol::spawn(<span class="kw">async move </span>{
<a href=#146 id=146 data-nosnippet>146</a> <span class="kw">if </span>!token.is_cancelled() {
<a href=#147 id=147 data-nosnippet>147</a> task().<span class="kw">await</span>;
<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="self">self</span>.tasks.lock().push(task_handle);
<a href=#152 id=152 data-nosnippet>152</a> }
<a href=#153 id=153 data-nosnippet>153</a>
<a href=#154 id=154 data-nosnippet>154</a> <span class="doccomment">/// Cancel all tasks in the group
<a href=#155 id=155 data-nosnippet>155</a> </span><span class="kw">pub fn </span>cancel(<span class="kw-2">&</span><span class="self">self</span>) {
<a href=#156 id=156 data-nosnippet>156</a> <span class="self">self</span>.token.cancel();
<a href=#157 id=157 data-nosnippet>157</a> }
<a href=#158 id=158 data-nosnippet>158</a>
<a href=#159 id=159 data-nosnippet>159</a> <span class="doccomment">/// Wait for all tasks to complete (non-blocking)
<a href=#160 id=160 data-nosnippet>160</a> </span><span class="kw">pub async fn </span>wait_all(<span class="kw-2">&</span><span class="self">self</span>) {
<a href=#161 id=161 data-nosnippet>161</a> <span class="kw">let </span>tasks = std::mem::take(<span class="kw-2">&mut *</span><span class="self">self</span>.tasks.lock());
<a href=#162 id=162 data-nosnippet>162</a> <span class="kw">for </span>task <span class="kw">in </span>tasks {
<a href=#163 id=163 data-nosnippet>163</a> <span class="kw">let </span>() = task.<span class="kw">await</span>;
<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>}
<a href=#167 id=167 data-nosnippet>167</a>
<a href=#168 id=168 data-nosnippet>168</a><span class="kw">impl </span>Default <span class="kw">for </span>AsyncTaskGroup {
<a href=#169 id=169 data-nosnippet>169</a> <span class="kw">fn </span>default() -> <span class="self">Self </span>{
<a href=#170 id=170 data-nosnippet>170</a> <span class="self">Self</span>::new()
<a href=#171 id=171 data-nosnippet>171</a> }
<a href=#172 id=172 data-nosnippet>172</a>}</code></pre></div></section></main></body></html>