| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129 |
- <!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 `FutureGuard` struct in crate `ocl`."><meta name="keywords" content="rust, rustlang, rust-lang, FutureGuard"><title>ocl::async::FutureGuard - 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="../../light.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 FutureGuard</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.set_lock_wait_events">set_lock_wait_events</a><a href="#method.ewait_lock">ewait_lock</a><a href="#method.create_lock_event">create_lock_event</a><a href="#method.enew_lock">enew_lock</a><a href="#method.set_command_wait_event">set_command_wait_event</a><a href="#method.ewait_command">ewait_command</a><a href="#method.create_release_event">create_release_event</a><a href="#method.enew_release">enew_release</a><a href="#method.lock_event">lock_event</a><a href="#method.release_event">release_event</a><a href="#method.wait">wait</a><a href="#method.as_ptr">as_ptr</a><a href="#method.as_mut_ptr">as_mut_ptr</a><a href="#method.order_lock">order_lock</a><a href="#method.upgrade_after_command">upgrade_after_command</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Future">Future</a><a href="#impl-Drop">Drop</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>ocl</a>::<wbr><a href='index.html'>async</a></p><script>window.sidebarCurrent = {name: 'FutureGuard', 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"><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'>Struct <a href='../index.html'>ocl</a>::<wbr><a href='index.html'>async</a>::<wbr><a class="struct" href=''>FutureGuard</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/ocl/async/order_lock.rs.html#272-283' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'><div class="docblock attributes">#[must_use = "futures do nothing unless polled"]
- </div>pub struct FutureGuard<V, G> <span class="where fmt-newline">where<br> G: <a class="trait" href="../../ocl/async/trait.OrderGuard.html" title="trait ocl::async::OrderGuard">OrderGuard</a><V>, </span> { /* fields omitted */ }</pre></div><div class='docblock'><p>A future that resolves to a read or write guard after ensuring that the
- data being guarded is appropriately locked during the execution of an
- OpenCL command.</p>
- <ol>
- <li>Waits until both an exclusive data lock can be obtained <strong>and</strong> all
- prerequisite OpenCL commands have completed.</li>
- <li>Triggers an OpenCL command, remaining locked while the command
- executes.</li>
- <li>Returns a guard which provides exclusive (write) or shared (read)
- access to the locked data.</li>
- </ol>
- </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'><table class='table-display'><tbody><tr><td><code>impl<V, G> <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><V, G> <span class="where fmt-newline">where<br> G: <a class="trait" href="../../ocl/async/trait.OrderGuard.html" title="trait ocl::async::OrderGuard">OrderGuard</a><V>, </span></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#285-676' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.set_lock_wait_events' class="method"><span id='set_lock_wait_events.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_lock_wait_events' class='fnname'>set_lock_wait_events</a><L: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../../ocl/struct.EventList.html" title="struct ocl::EventList">EventList</a>>>(&mut self, wait_events: L)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#309-312' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets an event wait list.</p>
- <p>Setting a wait list will cause this <code>FutureGuard</code> to wait until
- contained events have their status set to complete before obtaining a
- lock on the guarded internal value.</p>
- <p>[UNSTABLE]: This method may be renamed or otherwise changed at any time.</p>
- </div><h4 id='method.ewait_lock' class="method"><span id='ewait_lock.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.ewait_lock' class='fnname'>ewait_lock</a><L: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../../ocl/struct.EventList.html" title="struct ocl::EventList">EventList</a>>>(self, wait_events: L) -> <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><V, G></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#319-322' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets an event wait list.</p>
- <p>See <code>::set_lock_wait_events</code>.</p>
- <p>[UNSTABLE]: This method may be renamed or otherwise changed at any time.</p>
- </div><h4 id='method.create_lock_event' class="method"><span id='create_lock_event.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.create_lock_event' class='fnname'>create_lock_event</a><C: <a class="trait" href="../../ocl_core/types/abs/trait.ClContextPtr.html" title="trait ocl_core::types::abs::ClContextPtr">ClContextPtr</a>>(<br> &mut self, <br> context: C<br>) -> <a class="type" href="../../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a><&<a class="struct" href="../../ocl/struct.Event.html" title="struct ocl::Event">Event</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#333-337' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates an event which will be triggered when a lock is obtained on
- the guarded internal value.</p>
- <p>The returned event can be added to the wait list of subsequent OpenCL
- commands with the expectation that when all preceding futures are
- complete, the event will automatically be 'triggered' by having its
- status set to complete, causing those commands to execute. This can be
- used to inject host side code in amongst OpenCL commands without
- thread blocking or extra delays of any kind.</p>
- </div><h4 id='method.enew_lock' class="method"><span id='enew_lock.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.enew_lock' class='fnname'>enew_lock</a><C, En>(self, context: C, enew: En) -> <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><V, G> <span class="where fmt-newline">where<br> C: <a class="trait" href="../../ocl_core/types/abs/trait.ClContextPtr.html" title="trait ocl_core::types::abs::ClContextPtr">ClContextPtr</a>,<br> En: <a class="trait" href="../../ocl_core/types/abs/trait.ClNullEventPtr.html" title="trait ocl_core::types::abs::ClNullEventPtr">ClNullEventPtr</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#351-358' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates an event which will be triggered when a lock is obtained on
- the guarded internal value.</p>
- <p><code>enew</code> must be an empty (null) event or event list.</p>
- <p>See <code>::create_lock_event</code></p>
- <h2 id="panics" class="section-header"><a href="#panics">Panics</a></h2>
- <p>Panics if there is an error creating the lock event.</p>
- <p>[UNSTABLE]: This method may be renamed or otherwise changed at any time.</p>
- </div><h4 id='method.set_command_wait_event' class="method"><span id='set_command_wait_event.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_command_wait_event' class='fnname'>set_command_wait_event</a>(&mut self, command_event: <a class="struct" href="../../ocl/struct.Event.html" title="struct ocl::Event">Event</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#375-378' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets a command completion wait event.</p>
- <p><code>command_event</code> must be an event created by enqueuing an OpenCL
- command which interacts (reads/writes) with the data associated with
- this <code>FutureGuard</code>.</p>
- <p>If the command completion event is specified, this <code>FutureGuard</code> will
- "suffix" itself with an additional future that will wait until the
- command completes before resolving.</p>
- <p>Not specifying a command completion event will cause this
- <code>FutureGuard</code> to resolve into an <code>OrderGuard</code> immediately after the
- lock is obtained (indicated by the optionally created lock event).</p>
- <p>[UNSTABLE]: This method may be renamed or otherwise changed at any time.</p>
- </div><h4 id='method.ewait_command' class="method"><span id='ewait_command.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.ewait_command' class='fnname'>ewait_command</a>(self, command_event: <a class="struct" href="../../ocl/struct.Event.html" title="struct ocl::Event">Event</a>) -> <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><V, G></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#385-388' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets a command completion wait event.</p>
- <p>See <code>::set_command_wait_event</code>.</p>
- <p>[UNSTABLE]: This method may be renamed or otherwise changed at any time.</p>
- </div><h4 id='method.create_release_event' class="method"><span id='create_release_event.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.create_release_event' class='fnname'>create_release_event</a><C: <a class="trait" href="../../ocl_core/types/abs/trait.ClContextPtr.html" title="trait ocl_core::types::abs::ClContextPtr">ClContextPtr</a>>(<br> &mut self, <br> context: C<br>) -> <a class="type" href="../../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a><&<a class="struct" href="../../ocl/struct.Event.html" title="struct ocl::Event">Event</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#399-403' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates an event which will be triggered after this future resolves
- <strong>and</strong> the ensuing <code>OrderGuard</code> is dropped or manually released.</p>
- <p>The returned event can be added to the wait list of subsequent OpenCL
- commands with the expectation that when all preceding futures are
- complete, the event will automatically be 'triggered' by having its
- status set to complete, causing those commands to execute. This can be
- used to inject host side code in amongst OpenCL commands without
- thread blocking or extra delays of any kind.</p>
- </div><h4 id='method.enew_release' class="method"><span id='enew_release.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.enew_release' class='fnname'>enew_release</a><C, En>(self, context: C, enew: En) -> <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><V, G> <span class="where fmt-newline">where<br> C: <a class="trait" href="../../ocl_core/types/abs/trait.ClContextPtr.html" title="trait ocl_core::types::abs::ClContextPtr">ClContextPtr</a>,<br> En: <a class="trait" href="../../ocl_core/types/abs/trait.ClNullEventPtr.html" title="trait ocl_core::types::abs::ClNullEventPtr">ClNullEventPtr</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#417-424' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates an event which will be triggered after this future resolves
- <strong>and</strong> the ensuing <code>OrderGuard</code> is dropped or manually released.</p>
- <p><code>enew</code> must be an empty (null) event or event list.</p>
- <p>See <code>::create_release_event</code>.</p>
- <h2 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h2>
- <p>Panics if there is an error creating the release event.</p>
- <p>[UNSTABLE]: This method may be renamed or otherwise changed at any time.</p>
- </div><h4 id='method.lock_event' class="method"><span id='lock_event.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.lock_event' class='fnname'>lock_event</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../ocl/struct.Event.html" title="struct ocl::Event">Event</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#429-431' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the event previously created with
- <code>::create_lock_event</code> or <code>::enew_lock</code> which will trigger (be
- completed) when the wait events are complete and the lock is locked.</p>
- </div><h4 id='method.release_event' class="method"><span id='release_event.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.release_event' class='fnname'>release_event</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../ocl/struct.Event.html" title="struct ocl::Event">Event</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#436-438' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the event previously created with
- <code>::create_release_event</code> or <code>::enew_release</code> which will trigger (be
- completed) when a lock is obtained on the guarded internal value.</p>
- </div><h4 id='method.wait' class="method"><span id='wait.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.wait' class='fnname'>wait</a>(self) -> <a class="type" href="../../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a><G></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#442-444' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Blocks the current thread until the OpenCL command is complete and an
- appropriate lock can be obtained on the underlying data.</p>
- </div><h4 id='method.as_ptr' class="method"><span id='as_ptr.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.as_ptr' class='fnname'>as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const V</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#453-456' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a mutable pointer to the data contained within the internal
- value, bypassing all locks and protections.</p>
- <h2 id="panics-2" class="section-header"><a href="#panics-2">Panics</a></h2>
- <p>This future must not have already resolved into a guard.</p>
- </div><h4 id='method.as_mut_ptr' class="method"><span id='as_mut_ptr.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.as_mut_ptr' class='fnname'>as_mut_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut V</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#465-468' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a mutable pointer to the data contained within the internal
- value, bypassing all locks and protections.</p>
- <h2 id="panics-3" class="section-header"><a href="#panics-3">Panics</a></h2>
- <p>This future must not have already resolved into a guard.</p>
- </div><h4 id='method.order_lock' class="method"><span id='order_lock.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.order_lock' class='fnname'>order_lock</a>(&self) -> &<a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#476-478' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the <code>OrderLock</code> used to create this future.</p>
- </div></div><h3 id='impl-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<V> <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><V, <a class="struct" href="../../ocl/struct.ReadGuard.html" title="struct ocl::ReadGuard">ReadGuard</a><V>></code><a href='#impl-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#751-774' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.upgrade_after_command' class="method"><span id='upgrade_after_command.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.upgrade_after_command' class='fnname'>upgrade_after_command</a>(self) -> <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><V, <a class="struct" href="../../ocl/struct.WriteGuard.html" title="struct ocl::WriteGuard">WriteGuard</a><V>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#752-773' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div>
- <h2 id='implementations' class='small-section-header'>
- Trait Implementations<a href='#implementations' class='anchor'></a>
- </h2>
- <div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, G: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <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="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><V, G> <span class="where fmt-newline">where<br> G: <a class="trait" href="../../ocl/async/trait.OrderGuard.html" title="trait ocl::async::OrderGuard">OrderGuard</a><V>, </span></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#271' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &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="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#271' title='goto source code'>[src]</a></td></tr></tbody></table></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-Future' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<V, G> <a class="trait" href="../../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><V, G> <span class="where fmt-newline">where<br> G: <a class="trait" href="../../ocl/async/trait.OrderGuard.html" title="trait ocl::async::OrderGuard">OrderGuard</a><V>, </span></code><a href='#impl-Future' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#678-695' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='../../futures/future/trait.Future.html#associatedtype.Item' class="type">Item</a> = G</code></span></h4>
- <div class='docblock'><p>The type of value that this future will resolved with if it is successful. <a href="../../futures/future/trait.Future.html#associatedtype.Item">Read more</a></p>
- </div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='../../futures/future/trait.Future.html#associatedtype.Error' class="type">Error</a> = <a class="struct" href="../../ocl/error/struct.Error.html" title="struct ocl::error::Error">OclError</a></code></span></h4>
- <div class='docblock'><p>The type of error that this future will resolve with if it fails in a normal fashion. <a href="../../futures/future/trait.Future.html#associatedtype.Error">Read more</a></p>
- </div><h4 id='method.poll' class="method"><span id='poll.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#tymethod.poll' class='fnname'>poll</a>(&mut self) -> <a class="type" href="../../futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>, Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#683-694' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Query this future to see if its value has become available, registering interest if it is not. <a href="../../futures/future/trait.Future.html#tymethod.poll">Read more</a></p>
- </div><h4 id='method.wait-1' class="method"><span id='wait.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.wait' class='fnname'>wait</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>, Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#296-300' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Block the current thread until this future is resolved. <a href="../../futures/future/trait.Future.html#method.wait">Read more</a></p>
- </div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.map' class='fnname'>map</a><F, U>(self, f: F) -> <a class="struct" href="../../futures/future/map/struct.Map.html" title="struct futures::future::map::Map">Map</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>) -> U, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#370-375' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Map this future's result to a different type, returning a new future of the resulting type. <a href="../../futures/future/trait.Future.html#method.map">Read more</a></p>
- </div><h4 id='method.map_err' class="method"><span id='map_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.map_err' class='fnname'>map_err</a><F, E>(self, f: F) -> <a class="struct" href="../../futures/future/map_err/struct.MapErr.html" title="struct futures::future::map_err::MapErr">MapErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>) -> E, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#410-415' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Map this future's error to a different error, returning a new future. <a href="../../futures/future/trait.Future.html#method.map_err">Read more</a></p>
- </div><h4 id='method.from_err' class="method"><span id='from_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.from_err' class='fnname'>from_err</a><E>(self) -> <a class="struct" href="../../futures/future/from_err/struct.FromErr.html" title="struct futures::future::from_err::FromErr">FromErr</a><Self, E> <span class="where fmt-newline">where<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#440-444' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Map this future's error to any error implementing <code>From</code> for this future's <code>Error</code>, returning a new future. <a href="../../futures/future/trait.Future.html#method.from_err">Read more</a></p>
- </div><h4 id='method.then' class="method"><span id='then.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.then' class='fnname'>then</a><F, B>(self, f: F) -> <a class="struct" href="../../futures/future/then/struct.Then.html" title="struct futures::future::then::Then">Then</a><Self, B, F> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>, Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>) -> B, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#484-490' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Chain on a computation for when a future finished, passing the result of the future to the provided closure <code>f</code>. <a href="../../futures/future/trait.Future.html#method.then">Read more</a></p>
- </div><h4 id='method.and_then' class="method"><span id='and_then.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.and_then' class='fnname'>and_then</a><F, B>(self, f: F) -> <a class="struct" href="../../futures/future/and_then/struct.AndThen.html" title="struct futures::future::and_then::AndThen">AndThen</a><Self, B, F> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>) -> B, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#525-531' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Execute another future after this one has resolved successfully. <a href="../../futures/future/trait.Future.html#method.and_then">Read more</a></p>
- </div><h4 id='method.or_else' class="method"><span id='or_else.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.or_else' class='fnname'>or_else</a><F, B>(self, f: F) -> <a class="struct" href="../../futures/future/or_else/struct.OrElse.html" title="struct futures::future::or_else::OrElse">OrElse</a><Self, B, F> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>) -> B, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#566-572' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Execute another future if this one resolves with an error. <a href="../../futures/future/trait.Future.html#method.or_else">Read more</a></p>
- </div><h4 id='method.select' class="method"><span id='select.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.select' class='fnname'>select</a><B>(self, other: B) -> <a class="struct" href="../../futures/future/select/struct.Select.html" title="struct futures::future::select::Select">Select</a><Self, <B as <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>, Error = Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#624-631' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Waits for either one of two futures to complete. <a href="../../futures/future/trait.Future.html#method.select">Read more</a></p>
- </div><h4 id='method.select2' class="method"><span id='select2.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.select2' class='fnname'>select2</a><B>(self, other: B) -> <a class="struct" href="../../futures/future/select2/struct.Select2.html" title="struct futures::future::select2::Select2">Select2</a><Self, <B as <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#670-674' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Waits for either one of two differently-typed futures to complete. <a href="../../futures/future/trait.Future.html#method.select2">Read more</a></p>
- </div><h4 id='method.join' class="method"><span id='join.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.join' class='fnname'>join</a><B>(self, other: B) -> <a class="struct" href="../../futures/future/join/struct.Join.html" title="struct futures::future::join::Join">Join</a><Self, <B as <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#715-721' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Joins the result of two futures, waiting for them both to complete. <a href="../../futures/future/trait.Future.html#method.join">Read more</a></p>
- </div><h4 id='method.join3' class="method"><span id='join3.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.join3' class='fnname'>join3</a><B, C>(<br> self, <br> b: B, <br> c: C<br>) -> <a class="struct" href="../../futures/future/join/struct.Join3.html" title="struct futures::future::join::Join3">Join3</a><Self, <B as <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, <C as <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>,<br> C: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#724-730' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Same as <code>join</code>, but with more futures.</p>
- </div><h4 id='method.join4' class="method"><span id='join4.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.join4' class='fnname'>join4</a><B, C, D>(<br> self, <br> b: B, <br> c: C, <br> d: D<br>) -> <a class="struct" href="../../futures/future/join/struct.Join4.html" title="struct futures::future::join::Join4">Join4</a><Self, <B as <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, <C as <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, <D as <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>,<br> C: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>,<br> D: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#733-741' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Same as <code>join</code>, but with more futures.</p>
- </div><h4 id='method.join5' class="method"><span id='join5.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.join5' class='fnname'>join5</a><B, C, D, E>(<br> self, <br> b: B, <br> c: C, <br> d: D, <br> e: E<br>) -> <a class="struct" href="../../futures/future/join/struct.Join5.html" title="struct futures::future::join::Join5">Join5</a><Self, <B as <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, <C as <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, <D as <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>, <E as <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../../futures/future/trait.IntoFuture.html#associatedtype.Future" title="type futures::future::IntoFuture::Future">Future</a>> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>,<br> C: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>,<br> D: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>,<br> E: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#744-754' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Same as <code>join</code>, but with more futures.</p>
- </div><h4 id='method.into_stream' class="method"><span id='into_stream.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.into_stream' class='fnname'>into_stream</a>(self) -> <a class="struct" href="../../futures/future/into_stream/struct.IntoStream.html" title="struct futures::future::into_stream::IntoStream">IntoStream</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#777-781' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Convert this future into a single element stream. <a href="../../futures/future/trait.Future.html#method.into_stream">Read more</a></p>
- </div><h4 id='method.flatten' class="method"><span id='flatten.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.flatten' class='fnname'>flatten</a>(self) -> <a class="struct" href="../../futures/future/flatten/struct.Flatten.html" title="struct futures::future::flatten::Flatten">Flatten</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>,<br> <Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a> as <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../../futures/future/trait.IntoFuture.html#associatedtype.Error" title="type futures::future::IntoFuture::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#819-829' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Flatten the execution of this future when the successful result of this future is itself another future. <a href="../../futures/future/trait.Future.html#method.flatten">Read more</a></p>
- </div><h4 id='method.flatten_stream' class="method"><span id='flatten_stream.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.flatten_stream' class='fnname'>flatten_stream</a>(self) -> <a class="struct" href="../../futures/future/flatten_stream/struct.FlattenStream.html" title="struct futures::future::flatten_stream::FlattenStream">FlattenStream</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>: <a class="trait" href="../../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>,<br> <Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a> as <a class="trait" href="../../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="../../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a> == Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Error" title="type futures::future::Future::Error">Error</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#859-864' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Flatten the execution of this future when the successful result of this future is a stream. <a href="../../futures/future/trait.Future.html#method.flatten_stream">Read more</a></p>
- </div><h4 id='method.fuse' class="method"><span id='fuse.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.fuse' class='fnname'>fuse</a>(self) -> <a class="struct" href="../../futures/future/fuse/struct.Fuse.html" title="struct futures::future::fuse::Fuse">Fuse</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#899-904' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Fuse a future such that <code>poll</code> will never again be called once it has completed. <a href="../../futures/future/trait.Future.html#method.fuse">Read more</a></p>
- </div><h4 id='method.inspect' class="method"><span id='inspect.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.inspect' class='fnname'>inspect</a><F>(self, f: F) -> <a class="struct" href="../../futures/future/inspect/struct.Inspect.html" title="struct futures::future::inspect::Inspect">Inspect</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&Self::<a class="type" href="../../futures/future/trait.Future.html#associatedtype.Item" title="type futures::future::Future::Item">Item</a>), </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#922-927' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Do something with the item of a future, passing it on. <a href="../../futures/future/trait.Future.html#method.inspect">Read more</a></p>
- </div><h4 id='method.catch_unwind' class="method"><span id='catch_unwind.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.catch_unwind' class='fnname'>catch_unwind</a>(self) -> <a class="struct" href="../../futures/future/catch_unwind/struct.CatchUnwind.html" title="struct futures::future::catch_unwind::CatchUnwind">CatchUnwind</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#961-965' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Catches unwinding panics while polling the future. <a href="../../futures/future/trait.Future.html#method.catch_unwind">Read more</a></p>
- </div><h4 id='method.shared' class="method"><span id='shared.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../futures/future/trait.Future.html#method.shared' class='fnname'>shared</a>(self) -> <a class="struct" href="../../futures/future/shared/struct.Shared.html" title="struct futures::future::shared::Shared">Shared</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/future/mod.rs.html#1010-1014' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a cloneable handle to this future where all handles will resolve to the same result. <a href="../../futures/future/trait.Future.html#method.shared">Read more</a></p>
- </div></div><h3 id='impl-Drop' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<V, G> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><V, G> <span class="where fmt-newline">where<br> G: <a class="trait" href="../../ocl/async/trait.OrderGuard.html" title="trait ocl::async::OrderGuard">OrderGuard</a><V>, </span></code><a href='#impl-Drop' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#697-748' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.drop' class="method"><span id='drop.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#710-747' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Drops this FutureGuard.</p>
- <p>Blocks the current thread until the command associated with this
- <code>FutureGuard</code> (represented by the command completion event)
- completes. This ensures that the underlying value is not dropped
- before the command completes (which would cause obvious problems).</p>
- <h2 id="future_guard_drop_panic-feature" class="section-header"><a href="#future_guard_drop_panic-feature"><code>future_guard_drop_panic</code> Feature</a></h2>
- <p>If the <code>future_guard_drop_panic</code> feature is enabled, dropping a
- <code>FutureGuard</code> before it is polled will cause a panic.</p>
- </div></div></div>
- <h2 id='synthetic-implementations' class='small-section-header'>
- Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
- </h2>
- <div id='synthetic-implementations-list'>
- <h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<V, G> <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="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><V, G> <span class="where fmt-newline">where<br> G: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<V, G> <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="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><V, G> <span class="where fmt-newline">where<br> G: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "ocl";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
