mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-26 19:58:50 +01:00
22 lines
20 KiB
HTML
22 lines
20 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 `LocalSpawn` trait in crate `futures_task`."><meta name="keywords" content="rust, rustlang, rust-lang, LocalSpawn"><title>futures_task::LocalSpawn - 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_task/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Trait LocalSpawn</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.spawn_local_obj">spawn_local_obj</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.status_local">status_local</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-LocalSpawn-for-%26Sp">&Sp</a><a href="#impl-LocalSpawn-for-%26mut%20Sp">&mut Sp</a><a href="#impl-LocalSpawn-for-Arc%3CSp%3E">Arc<Sp></a><a href="#impl-LocalSpawn-for-Box%3CSp%3E">Box<Sp></a><a href="#impl-LocalSpawn-for-Rc%3CSp%3E">Rc<Sp></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">futures_task</a></p><div id="sidebar-vars" data-name="LocalSpawn" 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_task</a>::<wbr><a class="trait" href="">LocalSpawn</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/spawn.rs.html#31-52" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait LocalSpawn {
|
||
fn <a href="#tymethod.spawn_local_obj" class="fnname">spawn_local_obj</a>(<br> &self, <br> future: <a class="struct" href="../futures_task/struct.LocalFutureObj.html" title="struct futures_task::LocalFutureObj">LocalFutureObj</a><'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>><br> ) -> <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="../futures_task/struct.SpawnError.html" title="struct futures_task::SpawnError">SpawnError</a>>;
|
||
|
||
fn <a href="#method.status_local" class="fnname">status_local</a>(&self) -> <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="../futures_task/struct.SpawnError.html" title="struct futures_task::SpawnError">SpawnError</a>> { ... }
|
||
}</pre></div><div class="docblock"><p>The <code>LocalSpawn</code> is similar to <a href="../futures_task/trait.Spawn.html" title="Spawn"><code>Spawn</code></a>, but allows spawning futures
|
||
that don't implement <code>Send</code>.</p>
|
||
</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.spawn_local_obj" class="method"><code>fn <a href="#tymethod.spawn_local_obj" class="fnname">spawn_local_obj</a>(<br> &self, <br> future: <a class="struct" href="../futures_task/struct.LocalFutureObj.html" title="struct futures_task::LocalFutureObj">LocalFutureObj</a><'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>><br>) -> <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="../futures_task/struct.SpawnError.html" title="struct futures_task::SpawnError">SpawnError</a>></code><a class="srclink" href="../src/futures_task/spawn.rs.html#40" title="goto source code">[src]</a></h3><div class="docblock"><p>Spawns a future that will be run to completion.</p>
|
||
<h1 id="errors" class="section-header"><a href="#errors">Errors</a></h1>
|
||
<p>The executor may be unable to spawn tasks. Spawn errors should
|
||
represent relatively rare scenarios, such as the executor
|
||
having been shut down so that it is no longer able to accept
|
||
tasks.</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.status_local" class="method"><code>fn <a href="#method.status_local" class="fnname">status_local</a>(&self) -> <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="../futures_task/struct.SpawnError.html" title="struct futures_task::SpawnError">SpawnError</a>></code><a class="srclink" href="../src/futures_task/spawn.rs.html#49-51" title="goto source code">[src]</a></h3><div class="docblock"><p>Determines whether the executor is able to spawn new tasks.</p>
|
||
<p>This method will return <code>Ok</code> when the executor is <em>likely</em>
|
||
(but not guaranteed) to accept a subsequent spawn attempt.
|
||
Likewise, an <code>Err</code> return means that <code>spawn</code> is likely, but
|
||
not guaranteed, to yield an error.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-LocalSpawn-for-%26Sp" class="impl"><code class="in-band">impl<Sp: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../futures_task/trait.LocalSpawn.html" title="trait futures_task::LocalSpawn">LocalSpawn</a>> <a class="trait" href="../futures_task/trait.LocalSpawn.html" title="trait futures_task::LocalSpawn">LocalSpawn</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Sp</code><a href="#impl-LocalSpawn-for-%26Sp" class="anchor"></a><a class="srclink" href="../src/futures_task/spawn.rs.html#106-114" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.spawn_local_obj" class="method hidden"><code>fn <a href="#method.spawn_local_obj" class="fnname">spawn_local_obj</a>(<br> &self, <br> future: <a class="struct" href="../futures_task/struct.LocalFutureObj.html" title="struct futures_task::LocalFutureObj">LocalFutureObj</a><'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>><br>) -> <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="../futures_task/struct.SpawnError.html" title="struct futures_task::SpawnError">SpawnError</a>></code><a class="srclink" href="../src/futures_task/spawn.rs.html#107-109" title="goto source code">[src]</a></h4><h4 id="method.status_local-1" class="method hidden"><code>fn <a href="#method.status_local" class="fnname">status_local</a>(&self) -> <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="../futures_task/struct.SpawnError.html" title="struct futures_task::SpawnError">SpawnError</a>></code><a class="srclink" href="../src/futures_task/spawn.rs.html#111-113" title="goto source code">[src]</a></h4></div><h3 id="impl-LocalSpawn-for-%26mut%20Sp" class="impl"><code class="in-band">impl<Sp: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../futures_task/trait.LocalSpawn.html" title="trait futures_task::LocalSpawn">LocalSpawn</a>> <a class="trait" href="../futures_task/trait.LocalSpawn.html" title="trait futures_task::LocalSpawn">LocalSpawn</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Sp</code><a href="#impl-LocalSpawn-for-%26mut%20Sp" class="anchor"></a><a class="srclink" href="../src/futures_task/spawn.rs.html#116-124" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.spawn_local_obj-1" class="method hidden"><code>fn <a href="#method.spawn_local_obj" class="fnname">spawn_local_obj</a>(<br> &self, <br> future: <a class="struct" href="../futures_task/struct.LocalFutureObj.html" title="struct futures_task::LocalFutureObj">LocalFutureObj</a><'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>><br>) -> <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="../futures_task/struct.SpawnError.html" title="struct futures_task::SpawnError">SpawnError</a>></code><a class="srclink" href="../src/futures_task/spawn.rs.html#117-119" title="goto source code">[src]</a></h4><h4 id="method.status_local-2" class="method hidden"><code>fn <a href="#method.status_local" class="fnname">status_local</a>(&self) -> <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="../futures_task/struct.SpawnError.html" title="struct futures_task::SpawnError">SpawnError</a>></code><a class="srclink" href="../src/futures_task/spawn.rs.html#121-123" title="goto source code">[src]</a></h4></div><h3 id="impl-LocalSpawn-for-Box%3CSp%3E" class="impl"><code class="in-band">impl<Sp: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../futures_task/trait.LocalSpawn.html" title="trait futures_task::LocalSpawn">LocalSpawn</a>> <a class="trait" href="../futures_task/trait.LocalSpawn.html" title="trait futures_task::LocalSpawn">LocalSpawn</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Sp></code><a href="#impl-LocalSpawn-for-Box%3CSp%3E" class="anchor"></a><a class="srclink" href="../src/futures_task/spawn.rs.html#141-149" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.spawn_local_obj-2" class="method hidden"><code>fn <a href="#method.spawn_local_obj" class="fnname">spawn_local_obj</a>(<br> &self, <br> future: <a class="struct" href="../futures_task/struct.LocalFutureObj.html" title="struct futures_task::LocalFutureObj">LocalFutureObj</a><'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>><br>) -> <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="../futures_task/struct.SpawnError.html" title="struct futures_task::SpawnError">SpawnError</a>></code><a class="srclink" href="../src/futures_task/spawn.rs.html#142-144" title="goto source code">[src]</a></h4><h4 id="method.status_local-3" class="method hidden"><code>fn <a href="#method.status_local" class="fnname">status_local</a>(&self) -> <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="../futures_task/struct.SpawnError.html" title="struct futures_task::SpawnError">SpawnError</a>></code><a class="srclink" href="../src/futures_task/spawn.rs.html#146-148" title="goto source code">[src]</a></h4></div><h3 id="impl-LocalSpawn-for-Rc%3CSp%3E" class="impl"><code class="in-band">impl<Sp: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../futures_task/trait.LocalSpawn.html" title="trait futures_task::LocalSpawn">LocalSpawn</a>> <a class="trait" href="../futures_task/trait.LocalSpawn.html" title="trait futures_task::LocalSpawn">LocalSpawn</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><Sp></code><a href="#impl-LocalSpawn-for-Rc%3CSp%3E" class="anchor"></a><a class="srclink" href="../src/futures_task/spawn.rs.html#161-169" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.spawn_local_obj-3" class="method hidden"><code>fn <a href="#method.spawn_local_obj" class="fnname">spawn_local_obj</a>(<br> &self, <br> future: <a class="struct" href="../futures_task/struct.LocalFutureObj.html" title="struct futures_task::LocalFutureObj">LocalFutureObj</a><'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>><br>) -> <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="../futures_task/struct.SpawnError.html" title="struct futures_task::SpawnError">SpawnError</a>></code><a class="srclink" href="../src/futures_task/spawn.rs.html#162-164" title="goto source code">[src]</a></h4><h4 id="method.status_local-4" class="method hidden"><code>fn <a href="#method.status_local" class="fnname">status_local</a>(&self) -> <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="../futures_task/struct.SpawnError.html" title="struct futures_task::SpawnError">SpawnError</a>></code><a class="srclink" href="../src/futures_task/spawn.rs.html#166-168" title="goto source code">[src]</a></h4></div><h3 id="impl-LocalSpawn-for-Arc%3CSp%3E" class="impl"><code class="in-band">impl<Sp: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../futures_task/trait.LocalSpawn.html" title="trait futures_task::LocalSpawn">LocalSpawn</a>> <a class="trait" href="../futures_task/trait.LocalSpawn.html" title="trait futures_task::LocalSpawn">LocalSpawn</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Sp></code><a href="#impl-LocalSpawn-for-Arc%3CSp%3E" class="anchor"></a><a class="srclink" href="../src/futures_task/spawn.rs.html#184-192" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.spawn_local_obj-4" class="method hidden"><code>fn <a href="#method.spawn_local_obj" class="fnname">spawn_local_obj</a>(<br> &self, <br> future: <a class="struct" href="../futures_task/struct.LocalFutureObj.html" title="struct futures_task::LocalFutureObj">LocalFutureObj</a><'static, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>><br>) -> <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="../futures_task/struct.SpawnError.html" title="struct futures_task::SpawnError">SpawnError</a>></code><a class="srclink" href="../src/futures_task/spawn.rs.html#185-187" title="goto source code">[src]</a></h4><h4 id="method.status_local-5" class="method hidden"><code>fn <a href="#method.status_local" class="fnname">status_local</a>(&self) -> <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="../futures_task/struct.SpawnError.html" title="struct futures_task::SpawnError">SpawnError</a>></code><a class="srclink" href="../src/futures_task/spawn.rs.html#189-191" title="goto source code">[src]</a></h4></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/trait.LocalSpawn.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_task"></div>
|
||
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |