139 lines
37 KiB
HTML
139 lines
37 KiB
HTML
<!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="A handle to a runnable task."><title>Runnable in async_task - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="async_task" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="icon" href="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../async_task/index.html"><img src="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../async_task/index.html"><img src="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png" alt="logo"></a><h2><a href="../async_task/index.html">async_<wbr>task</a><span class="version">4.7.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Runnable</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.from_raw" title="from_raw">from_raw</a></li><li><a href="#method.into_raw" title="into_raw">into_raw</a></li><li><a href="#method.metadata" title="metadata">metadata</a></li><li><a href="#method.run" title="run">run</a></li><li><a href="#method.schedule" title="schedule">schedule</a></li><li><a href="#method.waker" title="waker">waker</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-Runnable%3CM%3E" title="Debug">Debug</a></li><li><a href="#impl-Drop-for-Runnable%3CM%3E" title="Drop">Drop</a></li><li><a href="#impl-RefUnwindSafe-for-Runnable%3CM%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Runnable%3CM%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-Runnable%3CM%3E" title="Sync">Sync</a></li><li><a href="#impl-UnwindSafe-for-Runnable%3CM%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Runnable%3CM%3E" title="Freeze">Freeze</a></li><li><a href="#impl-Unpin-for-Runnable%3CM%3E" title="Unpin">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate async_<wbr>task</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">async_task</a></span><h1>Struct <span class="struct">Runnable</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/async_task/runnable.rs.html#694-700">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Runnable<M = <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A handle to a runnable task.</p>
|
||
<p>Every spawned task has a single <a href="struct.Runnable.html" title="struct async_task::Runnable"><code>Runnable</code></a> handle, which only exists when the task is
|
||
scheduled for running.</p>
|
||
<p>Method <a href="struct.Runnable.html#method.run" title="method async_task::Runnable::run"><code>run()</code></a> polls the task’s future once. Then, the <a href="struct.Runnable.html" title="struct async_task::Runnable"><code>Runnable</code></a>
|
||
vanishes and only reappears when its <a href="https://doc.rust-lang.org/1.84.0/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>Waker</code></a> wakes the task, thus scheduling it to be run
|
||
again.</p>
|
||
<p>Dropping a <a href="struct.Runnable.html" title="struct async_task::Runnable"><code>Runnable</code></a> cancels the task, which means its future won’t be polled again, and
|
||
awaiting the <a href="struct.Task.html" title="struct async_task::Task"><code>Task</code></a> after that will result in a panic.</p>
|
||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>async_task::Runnable;
|
||
<span class="kw">use </span>once_cell::sync::Lazy;
|
||
<span class="kw">use </span>std::{panic, thread};
|
||
|
||
<span class="comment">// A simple executor.
|
||
</span><span class="kw">static </span>QUEUE: Lazy<flume::Sender<Runnable>> = Lazy::new(|| {
|
||
<span class="kw">let </span>(sender, receiver) = flume::unbounded::<Runnable>();
|
||
thread::spawn(|| {
|
||
<span class="kw">for </span>runnable <span class="kw">in </span>receiver {
|
||
<span class="kw">let </span>_ignore_panic = panic::catch_unwind(|| runnable.run());
|
||
}
|
||
});
|
||
sender
|
||
});
|
||
|
||
<span class="comment">// Create a task with a simple future.
|
||
</span><span class="kw">let </span>schedule = |runnable| QUEUE.send(runnable).unwrap();
|
||
<span class="kw">let </span>(runnable, task) = async_task::spawn(<span class="kw">async </span>{ <span class="number">1 </span>+ <span class="number">2 </span>}, schedule);
|
||
|
||
<span class="comment">// Schedule the task and await its output.
|
||
</span>runnable.schedule();
|
||
<span class="macro">assert_eq!</span>(smol::future::block_on(task), <span class="number">3</span>);</code></pre></div>
|
||
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Runnable%3CM%3E" class="impl"><a class="src rightside" href="../src/async_task/runnable.rs.html#710-891">Source</a><a href="#impl-Runnable%3CM%3E" class="anchor">§</a><h3 class="code-header">impl<M> <a class="struct" href="struct.Runnable.html" title="struct async_task::Runnable">Runnable</a><M></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.metadata" class="method"><a class="src rightside" href="../src/async_task/runnable.rs.html#715-717">Source</a><h4 class="code-header">pub fn <a href="#method.metadata" class="fn">metadata</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&M</a></h4></section></summary><div class="docblock"><p>Get the metadata associated with this task.</p>
|
||
<p>Tasks can be created with a metadata object associated with them; by default, this
|
||
is a <code>()</code> value. See the <a href="struct.Builder.html#method.metadata" title="method async_task::Builder::metadata"><code>Builder::metadata()</code></a> method for more information.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.schedule" class="method"><a class="src rightside" href="../src/async_task/runnable.rs.html#738-746">Source</a><h4 class="code-header">pub fn <a href="#method.schedule" class="fn">schedule</a>(self)</h4></section></summary><div class="docblock"><p>Schedules the task.</p>
|
||
<p>This is a convenience method that passes the <a href="struct.Runnable.html" title="struct async_task::Runnable"><code>Runnable</code></a> to the schedule function.</p>
|
||
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// A function that schedules the task when it gets woken up.
|
||
</span><span class="kw">let </span>(s, r) = flume::unbounded();
|
||
<span class="kw">let </span>schedule = <span class="kw">move </span>|runnable| s.send(runnable).unwrap();
|
||
|
||
<span class="comment">// Create a task with a simple future and the schedule function.
|
||
</span><span class="kw">let </span>(runnable, task) = async_task::spawn(<span class="kw">async </span>{}, schedule);
|
||
|
||
<span class="comment">// Schedule the task.
|
||
</span><span class="macro">assert_eq!</span>(r.len(), <span class="number">0</span>);
|
||
runnable.schedule();
|
||
<span class="macro">assert_eq!</span>(r.len(), <span class="number">1</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.run" class="method"><a class="src rightside" href="../src/async_task/runnable.rs.html#776-782">Source</a><h4 class="code-header">pub fn <a href="#method.run" class="fn">run</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Runs the task by polling its future.</p>
|
||
<p>Returns <code>true</code> if the task was woken while running, in which case the <a href="struct.Runnable.html" title="struct async_task::Runnable"><code>Runnable</code></a> gets
|
||
rescheduled at the end of this method invocation. Otherwise, returns <code>false</code> and the
|
||
<a href="struct.Runnable.html" title="struct async_task::Runnable"><code>Runnable</code></a> vanishes until the task is woken.
|
||
The return value is just a hint: <code>true</code> usually indicates that the task has yielded, i.e.
|
||
it woke itself and then gave the control back to the executor.</p>
|
||
<p>If the <a href="struct.Task.html" title="struct async_task::Task"><code>Task</code></a> handle was dropped or if <a href="struct.Task.html#method.cancel" title="method async_task::Task::cancel"><code>cancel()</code></a> was called, then
|
||
this method simply destroys the task.</p>
|
||
<p>If the polled future panics, this method propagates the panic, and awaiting the <a href="struct.Task.html" title="struct async_task::Task"><code>Task</code></a>
|
||
after that will also result in a panic.</p>
|
||
<h5 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// A function that schedules the task when it gets woken up.
|
||
</span><span class="kw">let </span>(s, r) = flume::unbounded();
|
||
<span class="kw">let </span>schedule = <span class="kw">move </span>|runnable| s.send(runnable).unwrap();
|
||
|
||
<span class="comment">// Create a task with a simple future and the schedule function.
|
||
</span><span class="kw">let </span>(runnable, task) = async_task::spawn(<span class="kw">async </span>{ <span class="number">1 </span>+ <span class="number">2 </span>}, schedule);
|
||
|
||
<span class="comment">// Run the task and check its output.
|
||
</span>runnable.run();
|
||
<span class="macro">assert_eq!</span>(smol::future::block_on(task), <span class="number">3</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.waker" class="method"><a class="src rightside" href="../src/async_task/runnable.rs.html#807-815">Source</a><h4 class="code-header">pub fn <a href="#method.waker" class="fn">waker</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker">Waker</a></h4></section></summary><div class="docblock"><p>Returns a waker associated with this task.</p>
|
||
<h5 id="examples-3"><a class="doc-anchor" href="#examples-3">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>smol::future;
|
||
|
||
<span class="comment">// A function that schedules the task when it gets woken up.
|
||
</span><span class="kw">let </span>(s, r) = flume::unbounded();
|
||
<span class="kw">let </span>schedule = <span class="kw">move </span>|runnable| s.send(runnable).unwrap();
|
||
|
||
<span class="comment">// Create a task with a simple future and the schedule function.
|
||
</span><span class="kw">let </span>(runnable, task) = async_task::spawn(future::pending::<()>(), schedule);
|
||
|
||
<span class="comment">// Take a waker and run the task.
|
||
</span><span class="kw">let </span>waker = runnable.waker();
|
||
runnable.run();
|
||
|
||
<span class="comment">// Reschedule the task by waking it.
|
||
</span><span class="macro">assert_eq!</span>(r.len(), <span class="number">0</span>);
|
||
waker.wake();
|
||
<span class="macro">assert_eq!</span>(r.len(), <span class="number">1</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_raw" class="method"><a class="src rightside" href="../src/async_task/runnable.rs.html#845-849">Source</a><h4 class="code-header">pub fn <a href="#method.into_raw" class="fn">into_raw</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/ptr/non_null/struct.NonNull.html" title="struct core::ptr::non_null::NonNull">NonNull</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Converts this task into a raw pointer.</p>
|
||
<p>To avoid a memory leak the pointer must be converted back to a Runnable using <a href="#method.from_raw"><code>Runnable<M>::from_raw</code></a>.</p>
|
||
<p><code>into_raw</code> does not change the state of the <a href="struct.Task.html" title="struct async_task::Task"><code>Task</code></a>, but there is no guarantee that it will be in the same state after calling <a href="#method.from_raw"><code>Runnable<M>::from_raw</code></a>,
|
||
as the corresponding <a href="struct.Task.html" title="struct async_task::Task"><code>Task</code></a> might have been dropped or cancelled.</p>
|
||
<h5 id="examples-4"><a class="doc-anchor" href="#examples-4">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>async_task::{Runnable, spawn};
|
||
<span class="kw">let </span>(runnable, task) = spawn(<span class="kw">async </span>{}, |<span class="kw">_</span>| {});
|
||
<span class="kw">let </span>runnable_pointer = runnable.into_raw();
|
||
|
||
<span class="kw">unsafe </span>{
|
||
<span class="comment">// Convert back to an `Runnable` to prevent leak.
|
||
</span><span class="kw">let </span>runnable = Runnable::<()>::from_raw(runnable_pointer);
|
||
runnable.run();
|
||
<span class="comment">// Further calls to `Runnable::from_raw(runnable_pointer)` would be memory-unsafe.
|
||
</span>}
|
||
<span class="comment">// The memory was freed when `x` went out of scope above, so `runnable_pointer` is now dangling!</span></code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.from_raw" class="method"><a class="src rightside" href="../src/async_task/runnable.rs.html#885-890">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.from_raw" class="fn">from_raw</a>(ptr: <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/ptr/non_null/struct.NonNull.html" title="struct core::ptr::non_null::NonNull">NonNull</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>>) -> Self</h4></section></summary><div class="docblock"><p>Converts a raw pointer into a Runnable.</p>
|
||
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
|
||
<p>This method should only be used with raw pointers returned from <a href="#method.into_raw"><code>Runnable<M>::into_raw</code></a>.
|
||
It is not safe to use the provided pointer once it is passed to <code>from_raw</code>.
|
||
Crucially, it is unsafe to call <code>from_raw</code> multiple times with the same pointer - even if the resulting <a href="struct.Runnable.html" title="struct async_task::Runnable"><code>Runnable</code></a> is not used -
|
||
as internally <code>async-task</code> uses reference counting.</p>
|
||
<p>It is however safe to call <a href="#method.into_raw"><code>Runnable<M>::into_raw</code></a> on a <a href="struct.Runnable.html" title="struct async_task::Runnable"><code>Runnable</code></a> created with <code>from_raw</code> or
|
||
after the <a href="struct.Task.html" title="struct async_task::Task"><code>Task</code></a> associated with a given Runnable has been dropped or cancelled.</p>
|
||
<p>The state of the <a href="struct.Runnable.html" title="struct async_task::Runnable"><code>Runnable</code></a> created with <code>from_raw</code> is not specified.</p>
|
||
<h5 id="examples-5"><a class="doc-anchor" href="#examples-5">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>async_task::{Runnable, spawn};
|
||
<span class="kw">let </span>(runnable, task) = spawn(<span class="kw">async </span>{}, |<span class="kw">_</span>| {});
|
||
<span class="kw">let </span>runnable_pointer = runnable.into_raw();
|
||
|
||
drop(task);
|
||
<span class="kw">unsafe </span>{
|
||
<span class="comment">// Convert back to an `Runnable` to prevent leak.
|
||
</span><span class="kw">let </span>runnable = Runnable::<()>::from_raw(runnable_pointer);
|
||
<span class="kw">let </span>did_poll = runnable.run();
|
||
<span class="macro">assert!</span>(!did_poll);
|
||
<span class="comment">// Further calls to `Runnable::from_raw(runnable_pointer)` would be memory-unsafe.
|
||
</span>}
|
||
<span class="comment">// The memory was freed when `x` went out of scope above, so `runnable_pointer` is now dangling!</span></code></pre></div>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Runnable%3CM%3E" class="impl"><a class="src rightside" href="../src/async_task/runnable.rs.html#936-945">Source</a><a href="#impl-Debug-for-Runnable%3CM%3E" class="anchor">§</a><h3 class="code-header">impl<M: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Runnable.html" title="struct async_task::Runnable">Runnable</a><M></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/async_task/runnable.rs.html#937-944">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Drop-for-Runnable%3CM%3E" class="impl"><a class="src rightside" href="../src/async_task/runnable.rs.html#893-934">Source</a><a href="#impl-Drop-for-Runnable%3CM%3E" class="anchor">§</a><h3 class="code-header">impl<M> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.Runnable.html" title="struct async_task::Runnable">Runnable</a><M></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl"><a class="src rightside" href="../src/async_task/runnable.rs.html#894-933">Source</a><a href="#method.drop" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/ops/drop/trait.Drop.html#tymethod.drop" class="fn">drop</a>(&mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.84.0/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></div></details></div></details><section id="impl-RefUnwindSafe-for-Runnable%3CM%3E" class="impl"><a class="src rightside" href="../src/async_task/runnable.rs.html#708">Source</a><a href="#impl-RefUnwindSafe-for-Runnable%3CM%3E" class="anchor">§</a><h3 class="code-header">impl<M> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Runnable.html" title="struct async_task::Runnable">Runnable</a><M></h3></section><section id="impl-Send-for-Runnable%3CM%3E" class="impl"><a class="src rightside" href="../src/async_task/runnable.rs.html#702">Source</a><a href="#impl-Send-for-Runnable%3CM%3E" class="anchor">§</a><h3 class="code-header">impl<M: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Runnable.html" title="struct async_task::Runnable">Runnable</a><M></h3></section><section id="impl-Sync-for-Runnable%3CM%3E" class="impl"><a class="src rightside" href="../src/async_task/runnable.rs.html#703">Source</a><a href="#impl-Sync-for-Runnable%3CM%3E" class="anchor">§</a><h3 class="code-header">impl<M: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Runnable.html" title="struct async_task::Runnable">Runnable</a><M></h3></section><section id="impl-UnwindSafe-for-Runnable%3CM%3E" class="impl"><a class="src rightside" href="../src/async_task/runnable.rs.html#706">Source</a><a href="#impl-UnwindSafe-for-Runnable%3CM%3E" class="anchor">§</a><h3 class="code-header">impl<M> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Runnable.html" title="struct async_task::Runnable">Runnable</a><M></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-Runnable%3CM%3E" class="impl"><a href="#impl-Freeze-for-Runnable%3CM%3E" class="anchor">§</a><h3 class="code-header">impl<M> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Runnable.html" title="struct async_task::Runnable">Runnable</a><M></h3></section><section id="impl-Unpin-for-Runnable%3CM%3E" class="impl"><a href="#impl-Unpin-for-Runnable%3CM%3E" class="anchor">§</a><h3 class="code-header">impl<M> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Runnable.html" title="struct async_task::Runnable">Runnable</a><M><div class="where">where
|
||
M: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#209">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#211">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#217">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#218">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#765">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#768">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#748-750">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#758">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#805-807">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#809">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#812">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#790-792">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#794">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#797">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |