<!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="Source to the Rust file `C:\Users\Chrilieb\.cargo\registry\src\github.com-1ecc6299db9ec823\ocl-0.14.1\src\async\mod.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>mod.rs.html -- source</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 source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
</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"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
</pre><pre class="rust ">
<span class="doccomment">//! Types related to futures and asynchrony.</span>
<span class="kw">mod</span> <span class="ident">error</span>;
<span class="kw">mod</span> <span class="ident">future_mem_map</span>;
<span class="kw">mod</span> <span class="ident">rw_vec</span>;
<span class="kw">mod</span> <span class="ident">mem_map</span>;
<span class="kw">use</span> <span class="ident">std</span>;
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">future</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">error</span>::{<span class="ident">Error</span>, <span class="prelude-ty">Result</span>};
<span class="comment">// pub use self::rw_vec::{RwVec, Guard, FutureGuard, RwGuard, FutureRwGuard};</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">rw_vec</span>::{<span class="ident">RwVec</span>, <span class="ident">ReadGuard</span>, <span class="ident">WriteGuard</span>, <span class="ident">FutureRwGuard</span>, <span class="ident">FutureReader</span>, <span class="ident">FutureWriter</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">mem_map</span>::<span class="ident">MemMap</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">future_mem_map</span>::<span class="ident">FutureMemMap</span>;
<span class="kw">pub</span> <span class="kw">type</span> <span class="ident">FutureResult</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="op">=</span> <span class="ident">future</span>::<span class="ident">FutureResult</span><span class="op"><</span><span class="ident">T</span>, <span class="self">self</span>::<span class="ident">Error</span><span class="op">></span>;
<span class="comment">// * TODO: Implement this:</span>
<span class="comment">//</span>
<span class="comment">// pub struct EventListTrigger {</span>
<span class="comment">// wait_events: EventList,</span>
<span class="comment">// completion_event: UserEvent,</span>
<span class="comment">// callback_is_set: bool,</span>
<span class="comment">// }</span>
<span class="comment">// pub struct EventTrigger {</span>
<span class="comment">// wait_event: Event,</span>
<span class="comment">// completion_event: UserEvent,</span>
<span class="comment">// callback_is_set: bool,</span>
<span class="comment">// }</span>
<span class="comment">// impl EventTrigger {</span>
<span class="comment">// pub fn new(wait_event: Event, completion_event: UserEvent) -> EventTrigger {</span>
<span class="comment">// EventTrigger {</span>
<span class="comment">// wait_event: wait_event,</span>
<span class="comment">// completion_event: completion_event ,</span>
<span class="comment">// callback_is_set: false,</span>
<span class="comment">// }</span>
<span class="comment">// }</span>
<span class="comment">// }</span>
<span class="doccomment">/// Creates a new "leaf future" which will resolve with the given result.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned future represents a computation which is finshed immediately.</span>
<span class="doccomment">/// This can be useful with the `finished` and `failed` base future types to</span>
<span class="doccomment">/// convert an immediate value to a future to interoperate elsewhere.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use ocl::async::result;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let future_of_1 = result::<u32>(Ok(1));</span>
<span class="doccomment">/// let future_of_err_2 = result::<u32>(Err("2".into()));</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="comment">//</span>
<span class="comment">// Shamelessly stolen from `https://github.com/alexcrichton/futures-rs`.</span>
<span class="comment">//</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">result</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="ident">r</span>: <span class="ident">std</span>::<span class="ident">result</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="self">self</span>::<span class="ident">Error</span><span class="op">></span>) <span class="op">-></span> <span class="self">self</span>::<span class="ident">FutureResult</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="ident">future</span>::<span class="ident">result</span>(<span class="ident">r</span>)
}
<span class="doccomment">/// Creates a "leaf future" from an immediate value of a finished and</span>
<span class="doccomment">/// successful computation.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned future is similar to `done` where it will immediately run a</span>
<span class="doccomment">/// scheduled callback with the provided value.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use ocl::async::ok;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let future_of_1 = ok::<u32>(1);</span>
<span class="doccomment">/// ```</span>
<span class="comment">//</span>
<span class="comment">// Shamelessly stolen from `https://github.com/alexcrichton/futures-rs`.</span>
<span class="comment">//</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">ok</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="ident">t</span>: <span class="ident">T</span>) <span class="op">-></span> <span class="self">self</span>::<span class="ident">FutureResult</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="ident">result</span>(<span class="prelude-val">Ok</span>(<span class="ident">t</span>))
}
<span class="doccomment">/// Creates a "leaf future" from an immediate value of a failed computation.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned future is similar to `done` where it will immediately run a</span>
<span class="doccomment">/// scheduled callback with the provided value.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use ocl::async::err;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let future_of_err_1 = err::<u32>("1".into());</span>
<span class="doccomment">/// ```</span>
<span class="comment">//</span>
<span class="comment">// Shamelessly stolen from `https://github.com/alexcrichton/futures-rs`.</span>
<span class="comment">//</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">err</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="ident">e</span>: <span class="self">self</span>::<span class="ident">Error</span>) <span class="op">-></span> <span class="self">self</span>::<span class="ident">FutureResult</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="ident">result</span>(<span class="prelude-val">Err</span>(<span class="ident">e</span>))
}</pre>
</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>