| <!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 `crates/stdx/src/thread.rs`."><title>thread.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" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-84e720fa.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="stdx" data-themes="" data-resource-suffix="" data-rustdoc-version="1.89.0 (29483883e 2025-08-04)" data-channel="1.89.0" data-search-js="search-92309212.js" data-settings-js="settings-5514c975.js" ><script src="../../static.files/storage-4e99c027.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-fd3af306.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.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><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">stdx/</div>thread.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">//! A utility module for working with threads that automatically joins threads upon drop |
| <a href=#2 id=2 data-nosnippet>2</a>//! and abstracts over operating system quality of service (`QoS`) APIs |
| <a href=#3 id=3 data-nosnippet>3</a>//! through the concept of a “thread intent”. |
| <a href=#4 id=4 data-nosnippet>4</a>//! |
| <a href=#5 id=5 data-nosnippet>5</a>//! The intent of a thread is frozen at thread creation time, |
| <a href=#6 id=6 data-nosnippet>6</a>//! i.e. there is no API to change the intent of a thread once it has been spawned. |
| <a href=#7 id=7 data-nosnippet>7</a>//! |
| <a href=#8 id=8 data-nosnippet>8</a>//! As a system, rust-analyzer should have the property that |
| <a href=#9 id=9 data-nosnippet>9</a>//! old manual scheduling APIs are replaced entirely by `QoS`. |
| <a href=#10 id=10 data-nosnippet>10</a>//! To maintain this invariant, we panic when it is clear that |
| <a href=#11 id=11 data-nosnippet>11</a>//! old scheduling APIs have been used. |
| <a href=#12 id=12 data-nosnippet>12</a>//! |
| <a href=#13 id=13 data-nosnippet>13</a>//! Moreover, we also want to ensure that every thread has an intent set explicitly |
| <a href=#14 id=14 data-nosnippet>14</a>//! to force a decision about its importance to the system. |
| <a href=#15 id=15 data-nosnippet>15</a>//! Thus, [`ThreadIntent`] has no default value |
| <a href=#16 id=16 data-nosnippet>16</a>//! and every entry point to creating a thread requires a [`ThreadIntent`] upfront. |
| <a href=#17 id=17 data-nosnippet>17</a> |
| <a href=#18 id=18 data-nosnippet>18</a></span><span class="kw">use </span>std::fmt; |
| <a href=#19 id=19 data-nosnippet>19</a> |
| <a href=#20 id=20 data-nosnippet>20</a><span class="kw">mod </span>intent; |
| <a href=#21 id=21 data-nosnippet>21</a><span class="kw">mod </span>pool; |
| <a href=#22 id=22 data-nosnippet>22</a> |
| <a href=#23 id=23 data-nosnippet>23</a><span class="kw">pub use </span>intent::ThreadIntent; |
| <a href=#24 id=24 data-nosnippet>24</a><span class="kw">pub use </span>pool::Pool; |
| <a href=#25 id=25 data-nosnippet>25</a> |
| <a href=#26 id=26 data-nosnippet>26</a><span class="doccomment">/// # Panics |
| <a href=#27 id=27 data-nosnippet>27</a>/// |
| <a href=#28 id=28 data-nosnippet>28</a>/// Panics if failed to spawn the thread. |
| <a href=#29 id=29 data-nosnippet>29</a></span><span class="kw">pub fn </span>spawn<F, T>(intent: ThreadIntent, name: String, f: F) -> JoinHandle<T> |
| <a href=#30 id=30 data-nosnippet>30</a><span class="kw">where |
| <a href=#31 id=31 data-nosnippet>31</a> </span>F: (FnOnce() -> T) + Send + <span class="lifetime">'static</span>, |
| <a href=#32 id=32 data-nosnippet>32</a> T: Send + <span class="lifetime">'static</span>, |
| <a href=#33 id=33 data-nosnippet>33</a>{ |
| <a href=#34 id=34 data-nosnippet>34</a> Builder::new(intent, name).spawn(f).expect(<span class="string">"failed to spawn thread"</span>) |
| <a href=#35 id=35 data-nosnippet>35</a>} |
| <a href=#36 id=36 data-nosnippet>36</a> |
| <a href=#37 id=37 data-nosnippet>37</a><span class="kw">pub struct </span>Builder { |
| <a href=#38 id=38 data-nosnippet>38</a> intent: ThreadIntent, |
| <a href=#39 id=39 data-nosnippet>39</a> inner: jod_thread::Builder, |
| <a href=#40 id=40 data-nosnippet>40</a> allow_leak: bool, |
| <a href=#41 id=41 data-nosnippet>41</a>} |
| <a href=#42 id=42 data-nosnippet>42</a> |
| <a href=#43 id=43 data-nosnippet>43</a><span class="kw">impl </span>Builder { |
| <a href=#44 id=44 data-nosnippet>44</a> <span class="attr">#[must_use] |
| <a href=#45 id=45 data-nosnippet>45</a> </span><span class="kw">pub fn </span>new(intent: ThreadIntent, name: <span class="kw">impl </span>Into<String>) -> <span class="self">Self </span>{ |
| <a href=#46 id=46 data-nosnippet>46</a> <span class="self">Self </span>{ intent, inner: jod_thread::Builder::new().name(name.into()), allow_leak: <span class="bool-val">false </span>} |
| <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="attr">#[must_use] |
| <a href=#50 id=50 data-nosnippet>50</a> </span><span class="kw">pub fn </span>stack_size(<span class="self">self</span>, size: usize) -> <span class="self">Self </span>{ |
| <a href=#51 id=51 data-nosnippet>51</a> <span class="self">Self </span>{ inner: <span class="self">self</span>.inner.stack_size(size), ..<span class="self">self </span>} |
| <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">/// Whether dropping should detach the thread |
| <a href=#55 id=55 data-nosnippet>55</a> /// instead of joining it. |
| <a href=#56 id=56 data-nosnippet>56</a> </span><span class="attr">#[must_use] |
| <a href=#57 id=57 data-nosnippet>57</a> </span><span class="kw">pub fn </span>allow_leak(<span class="self">self</span>, allow_leak: bool) -> <span class="self">Self </span>{ |
| <a href=#58 id=58 data-nosnippet>58</a> <span class="self">Self </span>{ allow_leak, ..<span class="self">self </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> <span class="kw">pub fn </span>spawn<F, T>(<span class="self">self</span>, f: F) -> std::io::Result<JoinHandle<T>> |
| <a href=#62 id=62 data-nosnippet>62</a> <span class="kw">where |
| <a href=#63 id=63 data-nosnippet>63</a> </span>F: (FnOnce() -> T) + Send + <span class="lifetime">'static</span>, |
| <a href=#64 id=64 data-nosnippet>64</a> T: Send + <span class="lifetime">'static</span>, |
| <a href=#65 id=65 data-nosnippet>65</a> { |
| <a href=#66 id=66 data-nosnippet>66</a> <span class="kw">let </span>inner_handle = <span class="self">self</span>.inner.spawn(<span class="kw">move </span>|| { |
| <a href=#67 id=67 data-nosnippet>67</a> <span class="self">self</span>.intent.apply_to_current_thread(); |
| <a href=#68 id=68 data-nosnippet>68</a> f() |
| <a href=#69 id=69 data-nosnippet>69</a> })<span class="question-mark">?</span>; |
| <a href=#70 id=70 data-nosnippet>70</a> |
| <a href=#71 id=71 data-nosnippet>71</a> <span class="prelude-val">Ok</span>(JoinHandle { inner: <span class="prelude-val">Some</span>(inner_handle), allow_leak: <span class="self">self</span>.allow_leak }) |
| <a href=#72 id=72 data-nosnippet>72</a> } |
| <a href=#73 id=73 data-nosnippet>73</a>} |
| <a href=#74 id=74 data-nosnippet>74</a> |
| <a href=#75 id=75 data-nosnippet>75</a><span class="kw">pub struct </span>JoinHandle<T = ()> { |
| <a href=#76 id=76 data-nosnippet>76</a> <span class="comment">// `inner` is an `Option` so that we can |
| <a href=#77 id=77 data-nosnippet>77</a> // take ownership of the contained `JoinHandle`. |
| <a href=#78 id=78 data-nosnippet>78</a> </span>inner: <span class="prelude-ty">Option</span><jod_thread::JoinHandle<T>>, |
| <a href=#79 id=79 data-nosnippet>79</a> allow_leak: bool, |
| <a href=#80 id=80 data-nosnippet>80</a>} |
| <a href=#81 id=81 data-nosnippet>81</a> |
| <a href=#82 id=82 data-nosnippet>82</a><span class="kw">impl</span><T> JoinHandle<T> { |
| <a href=#83 id=83 data-nosnippet>83</a> <span class="doccomment">/// # Panics |
| <a href=#84 id=84 data-nosnippet>84</a> /// |
| <a href=#85 id=85 data-nosnippet>85</a> /// Panics if there is no thread to join. |
| <a href=#86 id=86 data-nosnippet>86</a> </span><span class="attr">#[must_use] |
| <a href=#87 id=87 data-nosnippet>87</a> </span><span class="kw">pub fn </span>join(<span class="kw-2">mut </span><span class="self">self</span>) -> T { |
| <a href=#88 id=88 data-nosnippet>88</a> <span class="self">self</span>.inner.take().unwrap().join() |
| <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> |
| <a href=#92 id=92 data-nosnippet>92</a><span class="kw">impl</span><T> Drop <span class="kw">for </span>JoinHandle<T> { |
| <a href=#93 id=93 data-nosnippet>93</a> <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <a href=#94 id=94 data-nosnippet>94</a> <span class="kw">if </span>!<span class="self">self</span>.allow_leak { |
| <a href=#95 id=95 data-nosnippet>95</a> <span class="kw">return</span>; |
| <a href=#96 id=96 data-nosnippet>96</a> } |
| <a href=#97 id=97 data-nosnippet>97</a> |
| <a href=#98 id=98 data-nosnippet>98</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(join_handle) = <span class="self">self</span>.inner.take() { |
| <a href=#99 id=99 data-nosnippet>99</a> join_handle.detach(); |
| <a href=#100 id=100 data-nosnippet>100</a> } |
| <a href=#101 id=101 data-nosnippet>101</a> } |
| <a href=#102 id=102 data-nosnippet>102</a>} |
| <a href=#103 id=103 data-nosnippet>103</a> |
| <a href=#104 id=104 data-nosnippet>104</a><span class="kw">impl</span><T> fmt::Debug <span class="kw">for </span>JoinHandle<T> { |
| <a href=#105 id=105 data-nosnippet>105</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <a href=#106 id=106 data-nosnippet>106</a> f.pad(<span class="string">"JoinHandle { .. }"</span>) |
| <a href=#107 id=107 data-nosnippet>107</a> } |
| <a href=#108 id=108 data-nosnippet>108</a>}</code></pre></div></section></main></body></html> |
