<!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 `FutureRwGuard` struct in crate `ocl`.">
<meta name="keywords" content="rust, rustlang, rust-lang, FutureRwGuard">
<title>ocl::FutureRwGuard - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</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">
<p class='location'><a href='index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'FutureRwGuard', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>ocl</a>::<wbr><a class="struct" href=''>FutureRwGuard</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/rw_vec.rs.html#208-219' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'><div class="docblock attributes">#[must_use = "futures do nothing unless polled"]
</div>pub struct FutureRwGuard<T, G> { /* fields omitted */ }</pre><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'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl<T, G> <a class="struct" href="../ocl/struct.FutureRwGuard.html" title="struct ocl::FutureRwGuard">FutureRwGuard</a><T, G> <span class="where fmt-newline">where<br> G: RwGuard<T>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/async/rw_vec.rs.html#221-524' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.set_wait_list' class="method"><span id='set_wait_list.v' class='invisible'><code>fn <a href='#method.set_wait_list' class='fnname'>set_wait_list</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_list: L)</code></span></h4>
<div class='docblock'><p>Sets an event wait list.</p>
<p>Setting a wait list will cause this <code>FutureRwGuard</code> to wait until
contained events have their status set to complete before obtaining a
lock on the guarded internal <code>Vec</code>.</p>
<p>[UNSTABLE]: This method may be renamed or otherwise changed at any time.</p>
</div><h4 id='method.set_command_completion_event' class="method"><span id='set_command_completion_event.v' class='invisible'><code>fn <a href='#method.set_command_completion_event' class='fnname'>set_command_completion_event</a>(&mut self, command_completion: <a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>)</code></span></h4>
<div class='docblock'><p>Sets a command completion event.</p>
<p>If a command completion event corresponding to the read or write
command being executed in association with this <code>FutureRwGuard</code> is
specified before this <code>FutureRwGuard</code> is polled it will cause this
<code>FutureRwGuard</code> to suffix itself with an additional future that will
wait until the command completion event completes before resolving
into an <code>RwGuard</code>.</p>
<p>Not specifying a command completion event will cause this
<code>FutureRwGuard</code> to resolve into an <code>RwGuard</code> immediately after the
lock is obtained (indicated by the optionally created lock event).</p>
<p>TODO: Reword this.
[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'><code>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/async/type.Result.html" title="type ocl::async::Result">AsyncResult</a><&<a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>></code></span></h4>
<div class='docblock'><p>Creates an event which will be triggered when a lock is obtained on
the guarded internal <code>Vec</code>.</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.create_release_event' class="method"><span id='create_release_event.v' class='invisible'><code>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/async/type.Result.html" title="type ocl::async::Result">AsyncResult</a><&<a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>></code></span></h4>
<div class='docblock'><p>Creates an event which will be triggered after this future resolves
<strong>and</strong> the ensuing <code>RwGuard</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>
<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'><code>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></h4>
<div class='docblock'><p>Returns a reference to the event previously created with
<code>::create_lock_event</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'><code>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></h4>
<div class='docblock'><p>Returns a reference to the event previously created with
<code>::create_release_event</code> which will trigger (be completed) when a lock
is obtained on the guarded internal <code>Vec</code>.</p>
<p>[UNSTABLE]: This method may be renamed or otherwise changed at any time.</p>
</div><h4 id='method.wait' class="method"><span id='wait.v' class='invisible'><code>fn <a href='#method.wait' class='fnname'>wait</a>(self) -> <a class="type" href="../ocl/async/type.Result.html" title="type ocl::async::Result">AsyncResult</a><G></code></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_mut_ptr' class="method"><span id='as_mut_ptr.v' class='invisible'><code>unsafe fn <a href='#method.as_mut_ptr' class='fnname'>as_mut_ptr</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut T</a>></code></span></h4>
<div class='docblock'><p>Returns a mutable pointer to the data contained within the internal
<code>Vec</code>, bypassing all locks and protections.</p>
</div><h4 id='method.as_mut_slice' class="method"><span id='as_mut_slice.v' class='invisible'><code>unsafe fn <a href='#method.as_mut_slice' class='fnname'>as_mut_slice</a><'a, 'b>(&'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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'b mut [</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>></code></span></h4>
<div class='docblock'><p>Returns a mutable slice to the data contained within the internal
<code>Vec</code>, bypassing all locks and protections.</p>
</div><h4 id='method.len' class="method"><span id='len.v' class='invisible'><code>fn <a href='#method.len' class='fnname'>len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h4>
<div class='docblock'><p>Returns the length of the internal <code>Vec</code>.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<T> <a class="struct" href="../ocl/struct.FutureRwGuard.html" title="struct ocl::FutureRwGuard">FutureRwGuard</a><T, <a class="struct" href="../ocl/struct.ReadGuard.html" title="struct ocl::ReadGuard">ReadGuard</a><T>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/async/rw_vec.rs.html#561-584' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.upgrade_after_command' class="method"><span id='upgrade_after_command.v' class='invisible'><code>fn <a href='#method.upgrade_after_command' class='fnname'>upgrade_after_command</a>(self) -> <a class="type" href="../ocl/async/type.FutureWriter.html" title="type ocl::async::FutureWriter">FutureWriter</a><T></code></span></h4>
</div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl<T: <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/struct.FutureRwGuard.html" title="struct ocl::FutureRwGuard">FutureRwGuard</a><T, G></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/async/rw_vec.rs.html#207' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &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></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<T, G> <a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../ocl/struct.FutureRwGuard.html" title="struct ocl::FutureRwGuard">FutureRwGuard</a><T, G> <span class="where fmt-newline">where<br> G: RwGuard<T>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/async/rw_vec.rs.html#526-543' title='goto source code'>[src]</a></span></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="enum" href="../ocl/async/enum.Error.html" title="enum ocl::async::Error">AsyncError</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'><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="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Item</a>, Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>></code></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'><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="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Item</a>, Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>></code></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.boxed' class="method"><span id='boxed.v' class='invisible'><code>fn <a href='../futures/future/trait.Future.html#method.boxed' class='fnname'>boxed</a>(<br> self<br>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a><Error = Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>, Item = Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Item</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static, </span></code></span></h4>
<div class='docblock'><p>Convenience function for turning this future into a trait object which is also <code>Send</code>. <a href="../futures/future/trait.Future.html#method.boxed">Read more</a></p>
</div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><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/trait.FnOnce.html" title="trait core::ops::FnOnce">FnOnce</a>(Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Item</a>) -> U, </span></code></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'><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/trait.FnOnce.html" title="trait core::ops::FnOnce">FnOnce</a>(Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>) -> E, </span></code></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'><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="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>, </span></code></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'><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/trait.FnOnce.html" title="trait core::ops::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="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Item</a>, Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>) -> B, </span></code></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'><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="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.FnOnce.html" title="trait core::ops::FnOnce">FnOnce</a>(Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Item</a>) -> B, </span></code></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'><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="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Item</a>>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.FnOnce.html" title="trait core::ops::FnOnce">FnOnce</a>(Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>) -> B, </span></code></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'><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::<a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">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="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Item</a>, Error = Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>, </span></code></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'><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::<a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">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></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'><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::<a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">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="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>, </span></code></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'><code>fn <a href='../futures/future/trait.Future.html#method.join3' class='fnname'>join3</a><B, C>(self, b: B, c: C) -> <a class="struct" href="../futures/future/join/struct.Join3.html" title="struct futures::future::join::Join3">Join3</a><Self, B::<a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">Future</a>, C::<a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">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="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>,<br> C: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>, </span></code></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'><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::<a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">Future</a>, C::<a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">Future</a>, D::<a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">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="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>,<br> C: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>,<br> D: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>, </span></code></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'><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::<a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">Future</a>, C::<a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">Future</a>, D::<a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">Future</a>, E::<a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">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="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>,<br> C: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>,<br> D: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>,<br> E: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>, </span></code></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'><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></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'><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="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Item</a>: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>,<br> Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Item</a>::<a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">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="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>>, </span></code></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'><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="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Item</a>: <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>,<br> Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Item</a>::<a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Error</a> == Self::<a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Error</a>, </span></code></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'><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></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.catch_unwind' class="method"><span id='catch_unwind.v' class='invisible'><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></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'><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></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 class='impl'><span class='in-band'><code>impl<T, G> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.Drop.html" title="trait core::ops::Drop">Drop</a> for <a class="struct" href="../ocl/struct.FutureRwGuard.html" title="struct ocl::FutureRwGuard">FutureRwGuard</a><T, G></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/async/rw_vec.rs.html#545-558' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.drop' class="method"><span id='drop.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&mut self)</code></span></h4>
<div class='docblock'><p>Drops this FutureRwGuard.</p>
<p>Blocks the current thread until the command associated with this
<code>FutureRwGuard</code> (represented by the command completion event)
completes. This ensures that the underlying <code>Vec</code> is not dropped
before the command completes (which would cause obvious problems).</p>
</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "ocl";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>