mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-01 22:57:22 +01:00
34 lines
8.1 KiB
HTML
34 lines
8.1 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 `ArcWake` trait in crate `futures`."><meta name="keywords" content="rust, rustlang, rust-lang, ArcWake"><title>futures::task::ArcWake - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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><a href='../../futures/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait ArcWake</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.wake_by_ref">wake_by_ref</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.wake">wake</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">futures</a>::<wbr><a href="index.html">task</a></p><div id="sidebar-vars" data-name="ArcWake" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">futures</a>::<wbr><a href="index.html">task</a>::<wbr><a class="trait" href="">ArcWake</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/arc_wake.rs.html#20-49" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait ArcWake: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
|
||
pub fn <a href="#tymethod.wake_by_ref" class="fnname">wake_by_ref</a>(arc_self: &<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>);
|
||
|
||
pub fn <a href="#method.wake" class="fnname">wake</a>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>) { ... }
|
||
}</pre></div><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="../../futures/task/struct.Waker.html"><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="../../futures/task/struct.Waker.html"><code>Waker</code></a>:</p>
|
||
<ul>
|
||
<li><a href="../../futures/task/fn.waker.html"><code>waker</code></a> converts <code>Arc<impl ArcWake></code> into <a href="../../futures/task/struct.Waker.html"><code>Waker</code></a>.</li>
|
||
<li><a href="../../futures/task/fn.waker_ref.html"><code>waker_ref</code></a> converts <code>&Arc<impl ArcWake></code> into <a href="../../futures/task/struct.WakerRef.html"><code>WakerRef</code></a> that
|
||
provides access to a <a href="../../futures/task/struct.Waker.html"><code>&Waker</code></a>.</li>
|
||
</ul>
|
||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.wake_by_ref" class="method"><code>pub fn <a href="#tymethod.wake_by_ref" class="fnname">wake_by_ref</a>(arc_self: &<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>)</code><a class="srclink" href="../../src/futures_task/arc_wake.rs.html#48" title="goto source code">[src]</a></h3><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="../../futures/task/struct.Waker.html"><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="../../futures/task/trait.ArcWake.html#method.wake"><code>wake</code></a>, but must not consume the provided data
|
||
pointer.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><h3 id="method.wake" class="method"><code>pub fn <a href="#method.wake" class="fnname">wake</a>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>)</code><a class="srclink" href="../../src/futures_task/arc_wake.rs.html#31" title="goto source code">[src]</a></h3><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="../../futures/task/struct.Waker.html"><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></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/futures_task/arc_wake/trait.ArcWake.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |