<!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 `async` mod in crate `ocl`.">
<meta name="keywords" content="rust, rustlang, rust-lang, async">
<title>ocl::async - 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 mod">
<nav class="sidebar">
<p class='location'><a href='../index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'async', ty: 'mod', 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'>Module <a href='../index.html'>ocl</a>::<wbr><a class="mod" href=''>async</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/mod.rs.html#1-104' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Types related to futures and asynchrony.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.FutureMemMap.html"
title='struct ocl::async::FutureMemMap'>FutureMemMap</a></td>
<td class='docblock-short'>
<p>A future which resolves to a <code>MemMap</code> as soon as its creating command
completes.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.FutureRwGuard.html"
title='struct ocl::async::FutureRwGuard'>FutureRwGuard</a></td>
<td class='docblock-short'>
<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>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.MemMap.html"
title='struct ocl::async::MemMap'>MemMap</a></td>
<td class='docblock-short'>
<p>A view of memory mapped by <code>clEnqueueMap{...}</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.ReadGuard.html"
title='struct ocl::async::ReadGuard'>ReadGuard</a></td>
<td class='docblock-short'>
<p>Allows access to the data contained within a lock just like a mutex guard.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.RwVec.html"
title='struct ocl::async::RwVec'>RwVec</a></td>
<td class='docblock-short'>
<p>A locking <code>Vec</code> which interoperates with OpenCL events and Rust futures to
provide exclusive access to data.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.WriteGuard.html"
title='struct ocl::async::WriteGuard'>WriteGuard</a></td>
<td class='docblock-short'>
<p>Allows access to the data contained within just like a mutex guard.</p>
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class="enum" href="enum.Error.html"
title='enum ocl::async::Error'>Error</a></td>
<td class='docblock-short'>
<p>An enum containing either a <code>String</code> or one of several other error types.</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.err.html"
title='fn ocl::async::err'>err</a></td>
<td class='docblock-short'>
<p>Creates a "leaf future" from an immediate value of a failed computation.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.ok.html"
title='fn ocl::async::ok'>ok</a></td>
<td class='docblock-short'>
<p>Creates a "leaf future" from an immediate value of a finished and
successful computation.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.result.html"
title='fn ocl::async::result'>result</a></td>
<td class='docblock-short'>
<p>Creates a new "leaf future" which will resolve with the given result.</p>
</td>
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="type" href="type.FutureReader.html"
title='type ocl::async::FutureReader'>FutureReader</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="type" href="type.FutureResult.html"
title='type ocl::async::FutureResult'>FutureResult</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="type" href="type.FutureWriter.html"
title='type ocl::async::FutureWriter'>FutureWriter</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="type" href="type.Result.html"
title='type ocl::async::Result'>Result</a></td>
<td class='docblock-short'>
</td>
</tr></table></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>