180 lines
14 KiB
HTML
180 lines
14 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="API documentation for the Rust `AtomicTask` struct in crate `tokio`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, AtomicTask">
|
|||
|
|
|
|||
|
|
<title>tokio::prelude::task::AtomicTask - Rust</title>
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../../normalize.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle">
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../../dark.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../../main.css" id="themeStyle">
|
|||
|
|
<script src="../../../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc struct">
|
|||
|
|
<!--[if lte IE 8]>
|
|||
|
|
<div class="warning">
|
|||
|
|
This old browser is unsupported and will most likely display funky
|
|||
|
|
things.
|
|||
|
|
</div>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="sidebar">
|
|||
|
|
<div class="sidebar-menu">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Struct AtomicTask</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.register">register</a><a href="#method.register_task">register_task</a><a href="#method.notify">notify</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Sync">Sync</a><a href="#impl-Default">Default</a><a href="#impl-Debug">Debug</a><a href="#impl-Send">Send</a></div></div><p class='location'><a href='../../index.html'>tokio</a>::<wbr><a href='../index.html'>prelude</a>::<wbr><a href='index.html'>task</a></p><script>window.sidebarCurrent = {name: 'AtomicTask', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="theme-picker">
|
|||
|
|
<button id="theme-picker" aria-label="Pick another theme!">
|
|||
|
|
<img src="../../../brush.svg" width="18" alt="Pick another theme!">
|
|||
|
|
</button>
|
|||
|
|
<div id="theme-choices"></div>
|
|||
|
|
</div>
|
|||
|
|
<script src="../../../theme.js"></script>
|
|||
|
|
<nav class="sub">
|
|||
|
|
<form class="search-form js-only">
|
|||
|
|
<div class="search-container">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>tokio</a>::<wbr><a href='../index.html'>prelude</a>::<wbr><a href='index.html'>task</a>::<wbr><a class="struct" href=''>AtomicTask</a></span><span class='out-of-band'><span id='render-detail'>
|
|||
|
|
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
|||
|
|
[<span class='inner'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../../../src/futures/task_impl/atomic_task.rs.html#27-30' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct AtomicTask { /* fields omitted */ }</pre><div class='docblock'><p>A synchronization primitive for task notification.</p>
|
|||
|
|
<p><code>AtomicTask</code> will coordinate concurrent notifications with the consumer
|
|||
|
|
potentially "updating" the underlying task to notify. This is useful in
|
|||
|
|
scenarios where a computation completes in another thread and wants to
|
|||
|
|
notify the consumer, but the consumer is in the process of being migrated to
|
|||
|
|
a new logical task.</p>
|
|||
|
|
<p>Consumers should call <code>register</code> before checking the result of a computation
|
|||
|
|
and producers should call <code>notify</code> after producing the computation (this
|
|||
|
|
differs from the usual <code>thread::park</code> pattern). It is also permitted for
|
|||
|
|
<code>notify</code> to be called <strong>before</strong> <code>register</code>. This results in a no-op.</p>
|
|||
|
|
<p>A single <code>AtomicTask</code> may be reused for any number of calls to <code>register</code> or
|
|||
|
|
<code>notify</code>.</p>
|
|||
|
|
<p><code>AtomicTask</code> does not provide any memory ordering guarantees, as such the
|
|||
|
|
user should use caution and use other synchronization primitives to guard
|
|||
|
|
the result of the underlying computation.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='methods' class='small-section-header'>
|
|||
|
|
Methods<a href='#methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../../../tokio/prelude/task/struct.AtomicTask.html" title="struct tokio::prelude::task::AtomicTask">AtomicTask</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/task_impl/atomic_task.rs.html#137-279' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../../../tokio/prelude/task/struct.AtomicTask.html" title="struct tokio::prelude::task::AtomicTask">AtomicTask</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/task_impl/atomic_task.rs.html#139-148' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Create an <code>AtomicTask</code> initialized with the given <code>Task</code></p>
|
|||
|
|
</div><h4 id='method.register' class="method"><span id='register.v' class='invisible'><code>pub fn <a href='#method.register' class='fnname'>register</a>(&self)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/task_impl/atomic_task.rs.html#153-155' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Registers the current task to be notified on calls to <code>notify</code>.</p>
|
|||
|
|
<p>This is the same as calling <code>register_task</code> with <code>task::current()</code>.</p>
|
|||
|
|
</div><h4 id='method.register_task' class="method"><span id='register_task.v' class='invisible'><code>pub fn <a href='#method.register_task' class='fnname'>register_task</a>(&self, task: <a class="struct" href="../../../tokio/prelude/task/struct.Task.html" title="struct tokio::prelude::task::Task">Task</a>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/task_impl/atomic_task.rs.html#172-243' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Registers the provided task to be notified on calls to <code>notify</code>.</p>
|
|||
|
|
<p>The new task will take place of any previous tasks that were registered
|
|||
|
|
by previous calls to <code>register</code>. Any calls to <code>notify</code> that happen after
|
|||
|
|
a call to <code>register</code> (as defined by the memory ordering rules), will
|
|||
|
|
notify the <code>register</code> caller's task.</p>
|
|||
|
|
<p>It is safe to call <code>register</code> with multiple other threads concurrently
|
|||
|
|
calling <code>notify</code>. This will result in the <code>register</code> caller's current
|
|||
|
|
task being notified once.</p>
|
|||
|
|
<p>This function is safe to call concurrently, but this is generally a bad
|
|||
|
|
idea. Concurrent calls to <code>register</code> will attempt to register different
|
|||
|
|
tasks to be notified. One of the callers will win and have its task set,
|
|||
|
|
but there is no guarantee as to which caller will succeed.</p>
|
|||
|
|
</div><h4 id='method.notify' class="method"><span id='notify.v' class='invisible'><code>pub fn <a href='#method.notify' class='fnname'>notify</a>(&self)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/task_impl/atomic_task.rs.html#248-278' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Notifies the task that last called <code>register</code>.</p>
|
|||
|
|
<p>If <code>register</code> has not been called yet, then this does nothing.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-Sync' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../../tokio/prelude/task/struct.AtomicTask.html" title="struct tokio::prelude::task::AtomicTask">AtomicTask</a></code><a href='#impl-Sync' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/task_impl/atomic_task.rs.html#294' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'></div><h3 id='impl-Default' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../../../tokio/prelude/task/struct.AtomicTask.html" title="struct tokio::prelude::task::AtomicTask">AtomicTask</a></code><a href='#impl-Default' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/task_impl/atomic_task.rs.html#281-285' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../../../tokio/prelude/task/struct.AtomicTask.html" title="struct tokio::prelude::task::AtomicTask">AtomicTask</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/task_impl/atomic_task.rs.html#282-284' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../../tokio/prelude/task/struct.AtomicTask.html" title="struct tokio::prelude::task::AtomicTask">AtomicTask</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/task_impl/atomic_task.rs.html#287-291' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/task_impl/atomic_task.rs.html#288-290' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Send' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../../tokio/prelude/task/struct.AtomicTask.html" title="struct tokio::prelude::task::AtomicTask">AtomicTask</a></code><a href='#impl-Send' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/task_impl/atomic_task.rs.html#293' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'></div></section>
|
|||
|
|
<section id='search' class="content hidden"></section>
|
|||
|
|
|
|||
|
|
<section class="footer"></section>
|
|||
|
|
|
|||
|
|
<aside id="help" class="hidden">
|
|||
|
|
<div>
|
|||
|
|
<h1 class="hidden">Help</h1>
|
|||
|
|
|
|||
|
|
<div class="shortcuts">
|
|||
|
|
<h2>Keyboard Shortcuts</h2>
|
|||
|
|
|
|||
|
|
<dl>
|
|||
|
|
<dt><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse all sections</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="infos">
|
|||
|
|
<h2>Search Tricks</h2>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Prefix searches with a type followed by a colon (e.g.
|
|||
|
|
<code>fn:</code>) to restrict the search to a given type.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Accepted types are: <code>fn</code>, <code>mod</code>,
|
|||
|
|
<code>struct</code>, <code>enum</code>,
|
|||
|
|
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
|||
|
|
and <code>const</code>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Search functions by type signature (e.g.
|
|||
|
|
<code>vec -> usize</code> or <code>* -> vec</code>)
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../../../";
|
|||
|
|
window.currentCrate = "tokio";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../../main.js"></script>
|
|||
|
|
<script defer src="../../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|