mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
33 lines
9.2 KiB
HTML
33 lines
9.2 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 way of waking up a specific task."><title>ArcWake in futures_task - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="futures_task" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc trait"><!--[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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../futures_task/index.html">futures_task</a><span class="version">0.3.28</span></h2></div><h2 class="location"><a href="#">ArcWake</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.wake_by_ref">wake_by_ref</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.wake">wake</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate futures_task</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../futures_task/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">futures_task</a>::<wbr><a class="trait" href="#">ArcWake</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/futures_task/arc_wake.rs.html#20-49">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait ArcWake: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
|
||
// Required method
|
||
fn <a href="#tymethod.wake_by_ref" class="fn">wake_by_ref</a>(arc_self: &<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>);
|
||
|
||
// Provided method
|
||
fn <a href="#method.wake" class="fn">wake</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>) { ... }
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A way of waking up a specific task.</p>
|
||
<p>By implementing this trait, types that are expected to be wrapped in an <code>Arc</code>
|
||
can be converted into <a href="https://doc.rust-lang.org/1.76.0/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>Waker</code></a> objects.
|
||
Those Wakers can be used to signal executors that a task it owns
|
||
is ready to be <code>poll</code>ed again.</p>
|
||
<p>Currently, there are two ways to convert <code>ArcWake</code> into <a href="https://doc.rust-lang.org/1.76.0/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>Waker</code></a>:</p>
|
||
<ul>
|
||
<li><a href="fn.waker.html" title="fn futures_task::waker"><code>waker</code></a> converts <code>Arc<impl ArcWake></code> into <a href="https://doc.rust-lang.org/1.76.0/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>Waker</code></a>.</li>
|
||
<li><a href="fn.waker_ref.html" title="fn futures_task::waker_ref"><code>waker_ref</code></a> converts <code>&Arc<impl ArcWake></code> into <a href="struct.WakerRef.html" title="struct futures_task::WakerRef"><code>WakerRef</code></a> that
|
||
provides access to a <a href="https://doc.rust-lang.org/1.76.0/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>&Waker</code></a>.</li>
|
||
</ul>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.wake_by_ref" class="method"><a class="src rightside" href="../src/futures_task/arc_wake.rs.html#48">source</a><h4 class="code-header">fn <a href="#tymethod.wake_by_ref" class="fn">wake_by_ref</a>(arc_self: &<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>)</h4></section></summary><div class="docblock"><p>Indicates that the associated task is ready to make progress and should
|
||
be <code>poll</code>ed.</p>
|
||
<p>This function can be called from an arbitrary thread, including threads which
|
||
did not create the <code>ArcWake</code> based <a href="https://doc.rust-lang.org/1.76.0/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>Waker</code></a>.</p>
|
||
<p>Executors generally maintain a queue of “ready” tasks; <code>wake_by_ref</code> should place
|
||
the associated task onto this queue.</p>
|
||
<p>This function is similar to <a href="trait.ArcWake.html#method.wake" title="method futures_task::ArcWake::wake"><code>wake</code></a>, but must not consume the provided data
|
||
pointer.</p>
|
||
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.wake" class="method"><a class="src rightside" href="../src/futures_task/arc_wake.rs.html#31-33">source</a><h4 class="code-header">fn <a href="#method.wake" class="fn">wake</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>)</h4></section></summary><div class="docblock"><p>Indicates that the associated task is ready to make progress and should
|
||
be <code>poll</code>ed.</p>
|
||
<p>This function can be called from an arbitrary thread, including threads which
|
||
did not create the <code>ArcWake</code> based <a href="https://doc.rust-lang.org/1.76.0/core/task/wake/struct.Waker.html" title="struct core::task::wake::Waker"><code>Waker</code></a>.</p>
|
||
<p>Executors generally maintain a queue of “ready” tasks; <code>wake</code> should place
|
||
the associated task onto this queue.</p>
|
||
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/futures_task/arc_wake/trait.ArcWake.js" async></script></section></div></main></body></html> |