| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/tokio-1.28.2/src/runtime/task/abort.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>abort.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../../normalize.css"><link rel="stylesheet" href="../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../../ayu.css" disabled><link rel="stylesheet" href="../../../../dark.css" disabled><link rel="stylesheet" href="../../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../../storage.js"></script><script defer src="../../../../source-script.js"></script><script defer src="../../../../source-files.js"></script><script defer src="../../../../main.js"></script><noscript><link rel="stylesheet" href="../../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../tokio/index.html"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::runtime::task::{Header, RawTask}; |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::panic::{RefUnwindSafe, UnwindSafe}; |
| |
| <span class="doccomment">/// An owned permission to abort a spawned task, without awaiting its completion. |
| /// |
| /// Unlike a [`JoinHandle`], an `AbortHandle` does *not* represent the |
| /// permission to await the task's completion, only to terminate it. |
| /// |
| /// The task may be aborted by calling the [`AbortHandle::abort`] method. |
| /// Dropping an `AbortHandle` releases the permission to terminate the task |
| /// --- it does *not* abort the task. |
| /// |
| /// [`JoinHandle`]: crate::task::JoinHandle |
| </span><span class="attribute">#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"rt"</span>)))] |
| </span><span class="kw">pub struct </span>AbortHandle { |
| raw: RawTask, |
| } |
| |
| <span class="kw">impl </span>AbortHandle { |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(raw: RawTask) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ raw } |
| } |
| |
| <span class="doccomment">/// Abort the task associated with the handle. |
| /// |
| /// Awaiting a cancelled task might complete as usual if the task was |
| /// already completed at the time it was cancelled, but most likely it |
| /// will fail with a [cancelled] `JoinError`. |
| /// |
| /// If the task was already cancelled, such as by [`JoinHandle::abort`], |
| /// this method will do nothing. |
| /// |
| /// [cancelled]: method@super::error::JoinError::is_cancelled |
| /// [`JoinHandle::abort`]: method@super::JoinHandle::abort |
| </span><span class="kw">pub fn </span>abort(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="self">self</span>.raw.remote_abort(); |
| } |
| |
| <span class="doccomment">/// Checks if the task associated with this `AbortHandle` has finished. |
| /// |
| /// Please note that this method can return `false` even if `abort` has been |
| /// called on the task. This is because the cancellation process may take |
| /// some time, and this method does not return `true` until it has |
| /// completed. |
| </span><span class="kw">pub fn </span>is_finished(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="kw">let </span>state = <span class="self">self</span>.raw.state().load(); |
| state.is_complete() |
| } |
| |
| <span class="doccomment">/// Returns a [task ID] that uniquely identifies this task relative to other |
| /// currently spawned tasks. |
| /// |
| /// **Note**: This is an [unstable API][unstable]. The public API of this type |
| /// may break in 1.x releases. See [the documentation on unstable |
| /// features][unstable] for details. |
| /// |
| /// [task ID]: crate::task::Id |
| /// [unstable]: crate#unstable-features |
| </span><span class="attribute">#[cfg(tokio_unstable)] |
| #[cfg_attr(docsrs, doc(cfg(tokio_unstable)))] |
| </span><span class="kw">pub fn </span>id(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw">super</span>::Id { |
| <span class="comment">// Safety: The header pointer is valid. |
| </span><span class="kw">unsafe </span>{ Header::get_id(<span class="self">self</span>.raw.header_ptr()) } |
| } |
| } |
| |
| <span class="kw">unsafe impl </span>Send <span class="kw">for </span>AbortHandle {} |
| <span class="kw">unsafe impl </span>Sync <span class="kw">for </span>AbortHandle {} |
| |
| <span class="kw">impl </span>UnwindSafe <span class="kw">for </span>AbortHandle {} |
| <span class="kw">impl </span>RefUnwindSafe <span class="kw">for </span>AbortHandle {} |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>AbortHandle { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="comment">// Safety: The header pointer is valid. |
| </span><span class="kw">let </span>id_ptr = <span class="kw">unsafe </span>{ Header::get_id_ptr(<span class="self">self</span>.raw.header_ptr()) }; |
| <span class="kw">let </span>id = <span class="kw">unsafe </span>{ id_ptr.as_ref() }; |
| fmt.debug_struct(<span class="string">"AbortHandle"</span>).field(<span class="string">"id"</span>, id).finish() |
| } |
| } |
| |
| <span class="kw">impl </span>Drop <span class="kw">for </span>AbortHandle { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.raw.drop_abort_handle(); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
