<!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\future_mem_map.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>future_mem_map.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>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
</pre><pre class="rust ">
<span class="kw">use</span> <span class="ident">futures</span>::{<span class="ident">Future</span>, <span class="ident">Poll</span>, <span class="ident">Async</span>};
<span class="kw">use</span> <span class="ident">core</span>::{<span class="ident">OclPrm</span>, <span class="ident">MemMap</span> <span class="kw">as</span> <span class="ident">MemMapCore</span>, <span class="ident">Mem</span>};
<span class="kw">use</span> <span class="ident">standard</span>::{<span class="ident">Event</span>, <span class="ident">Queue</span>, <span class="ident">EventList</span>};
<span class="kw">use</span> <span class="kw">super</span>::{<span class="ident">Error</span> <span class="kw">as</span> <span class="ident">AsyncError</span>, <span class="prelude-ty">Result</span> <span class="kw">as</span> <span class="ident">AsyncResult</span>, <span class="ident">MemMap</span>};
<span class="doccomment">/// A future which resolves to a `MemMap` as soon as its creating command</span>
<span class="doccomment">/// completes.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [UNSTABLE]: This types methods may be renamed or otherwise changed at any time.</span>
<span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">"futures do nothing unless polled"</span>]</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">FutureMemMap</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">OclPrm</span><span class="op">></span> {
<span class="ident">core</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">MemMapCore</span><span class="op"><</span><span class="ident">T</span><span class="op">>></span>,
<span class="ident">len</span>: <span class="ident">usize</span>,
<span class="ident">map_event</span>: <span class="ident">Event</span>,
<span class="ident">unmap_wait_list</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">EventList</span><span class="op">></span>,
<span class="ident">unmap_target_event</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Event</span><span class="op">></span>,
<span class="ident">buffer</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Mem</span><span class="op">></span>,
<span class="ident">queue</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Queue</span><span class="op">></span>,
<span class="ident">callback_is_set</span>: <span class="ident">bool</span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">OclPrm</span><span class="op">></span> <span class="ident">FutureMemMap</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="doccomment">/// Returns a new `FutureMemMap`.</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">core</span>: <span class="ident">MemMapCore</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>, <span class="ident">len</span>: <span class="ident">usize</span>, <span class="ident">map_event</span>: <span class="ident">Event</span>, <span class="ident">buffer</span>: <span class="ident">Mem</span>, <span class="ident">queue</span>: <span class="ident">Queue</span>)
<span class="op">-></span> <span class="ident">FutureMemMap</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>
{
<span class="ident">FutureMemMap</span> {
<span class="ident">core</span>: <span class="prelude-val">Some</span>(<span class="ident">core</span>),
<span class="ident">len</span>: <span class="ident">len</span>,
<span class="ident">map_event</span>: <span class="ident">map_event</span>,
<span class="ident">unmap_wait_list</span>: <span class="prelude-val">None</span>,
<span class="ident">unmap_target_event</span>: <span class="prelude-val">None</span>,
<span class="ident">buffer</span>: <span class="prelude-val">Some</span>(<span class="ident">buffer</span>),
<span class="ident">queue</span>: <span class="prelude-val">Some</span>(<span class="ident">queue</span>),
<span class="ident">callback_is_set</span>: <span class="bool-val">false</span>,
}
}
<span class="doccomment">/// Set an event wait list for the unmap command.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Setting a wait list here will disallow any wait list from being set</span>
<span class="doccomment">/// later if/when calling unmap manually.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [UNSTABLE]: This method may be renamed or otherwise changed.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_unmap_wait_list</span><span class="op"><</span><span class="ident">El</span><span class="op">></span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">wait_list</span>: <span class="ident">El</span>) <span class="kw">where</span> <span class="ident">El</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">EventList</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">unmap_wait_list</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">wait_list</span>.<span class="ident">into</span>())
}
<span class="doccomment">/// Create an event which will be triggered (set complete) after this</span>
<span class="doccomment">/// future resolves into a `MemMap` **and** after that `MemMap` is dropped</span>
<span class="doccomment">/// or manually unmapped.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned event can be added to the wait list of subsequent OpenCL</span>
<span class="doccomment">/// commands with the expectation that when all preceeding futures are</span>
<span class="doccomment">/// complete, the event will automatically be 'triggered' by having its</span>
<span class="doccomment">/// status set to complete, causing those commands to execute. This can be</span>
<span class="doccomment">/// used to inject host side code in amongst OpenCL commands without</span>
<span class="doccomment">/// thread blocking or extra delays of any kind.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [UNSTABLE]: This method may be renamed or otherwise changed.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">create_unmap_target_event</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">AsyncResult</span><span class="op"><</span><span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">Event</span><span class="op">></span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">queue</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">queue</span> {
<span class="kw">let</span> <span class="ident">uev</span> <span class="op">=</span> <span class="ident">Event</span>::<span class="ident">user</span>(<span class="kw-2">&</span><span class="ident">queue</span>.<span class="ident">context</span>())<span class="question-mark">?</span>;
<span class="self">self</span>.<span class="ident">unmap_target_event</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">uev</span>);
<span class="prelude-val">Ok</span>(<span class="self">self</span>.<span class="ident">unmap_target_event</span>.<span class="ident">as_mut</span>().<span class="ident">unwrap</span>())
} <span class="kw">else</span> {
<span class="prelude-val">Err</span>(<span class="string">"FutureMemMap::create_unmap_target_event: No queue found!"</span>.<span class="ident">into</span>())
}
}
<span class="doccomment">/// Blocks the current thread until the OpenCL command is complete and an</span>
<span class="doccomment">/// appropriate lock can be obtained on the underlying data.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">wait</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">AsyncResult</span><span class="op"><</span><span class="ident">MemMap</span><span class="op"><</span><span class="ident">T</span><span class="op">>></span> {
<span class="op"><</span><span class="self">Self</span> <span class="kw">as</span> <span class="ident">Future</span><span class="op">></span>::<span class="ident">wait</span>(<span class="self">self</span>)
}
<span class="doccomment">/// Returns the unmap event if it has been created.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [UNSTABLE]: This method may be renamed or otherwise changed.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">unmap_target_event</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">Event</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">unmap_target_event</span>.<span class="ident">as_ref</span>()
}
<span class="doccomment">/// Resolves this `FutureMemMap` into a `MemMap`.</span>
<span class="kw">fn</span> <span class="ident">to_mapped_mem</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">AsyncResult</span><span class="op"><</span><span class="ident">MemMap</span><span class="op"><</span><span class="ident">T</span><span class="op">>></span> {
<span class="kw">let</span> <span class="ident">joined</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">core</span>.<span class="ident">take</span>().<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">core</span><span class="op">|</span> {
<span class="self">self</span>.<span class="ident">buffer</span>.<span class="ident">take</span>().<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">buf</span><span class="op">|</span> {
<span class="self">self</span>.<span class="ident">queue</span>.<span class="ident">take</span>().<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">queue</span><span class="op">|</span> {
<span class="prelude-val">Some</span>((<span class="ident">core</span>, <span class="ident">buf</span>, <span class="ident">queue</span>))
})
})
});
<span class="kw">match</span> <span class="ident">joined</span> {
<span class="prelude-val">Some</span>((<span class="ident">core</span>, <span class="ident">buffer</span>, <span class="ident">queue</span>)) <span class="op">=></span> {
<span class="kw">unsafe</span> { <span class="prelude-val">Ok</span>(<span class="ident">MemMap</span>::<span class="ident">new</span>(<span class="ident">core</span>, <span class="self">self</span>.<span class="ident">len</span>, <span class="self">self</span>.<span class="ident">unmap_wait_list</span>.<span class="ident">take</span>(),
<span class="self">self</span>.<span class="ident">unmap_target_event</span>.<span class="ident">take</span>(), <span class="ident">buffer</span>, <span class="ident">queue</span> )) }
},
_ <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="string">"FutureMemMap::create_unmap_target_event: No queue and/or buffer found!"</span>.<span class="ident">into</span>()),
}
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"async_block"</span>))]</span>
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Future</span> <span class="kw">for</span> <span class="ident">FutureMemMap</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">where</span> <span class="ident">T</span>: <span class="ident">OclPrm</span> <span class="op">+</span> <span class="lifetime">'static</span> {
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">MemMap</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>;
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">AsyncError</span>;
<span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span> {
<span class="comment">// println!("Polling FutureMemMap...");</span>
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">map_event</span>.<span class="ident">is_complete</span>() {
<span class="prelude-val">Ok</span>(<span class="bool-val">true</span>) <span class="op">=></span> {
<span class="self">self</span>.<span class="ident">to_mapped_mem</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">mm</span><span class="op">|</span> <span class="ident">Async</span>::<span class="ident">Ready</span>(<span class="ident">mm</span>))
}
<span class="prelude-val">Ok</span>(<span class="bool-val">false</span>) <span class="op">=></span> {
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">callback_is_set</span> {
<span class="self">self</span>.<span class="ident">map_event</span>.<span class="ident">set_unpark_callback</span>()<span class="question-mark">?</span>;
<span class="self">self</span>.<span class="ident">callback_is_set</span> <span class="op">=</span> <span class="bool-val">true</span>;
}
<span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">NotReady</span>)
},
<span class="prelude-val">Err</span>(<span class="ident">err</span>) <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="ident">err</span>.<span class="ident">into</span>()),
}
}
}
<span class="doccomment">/// Blocking implementation.</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"async_block"</span>)]</span>
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">OclPrm</span><span class="op">></span> <span class="ident">Future</span> <span class="kw">for</span> <span class="ident">FutureMemMap</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">MemMap</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>;
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">AsyncError</span>;
<span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span> {
<span class="comment">// println!("Polling FutureMemMap...");</span>
<span class="kw">let</span> _ <span class="op">=</span> <span class="self">self</span>.<span class="ident">callback_is_set</span>;
<span class="self">self</span>.<span class="ident">map_event</span>.<span class="ident">wait_for</span>()<span class="question-mark">?</span>;
<span class="self">self</span>.<span class="ident">to_mapped_mem</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">mm</span><span class="op">|</span> <span class="ident">Async</span>::<span class="ident">Ready</span>(<span class="ident">mm</span>))
}
}
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">OclPrm</span><span class="op">></span> <span class="ident">Send</span> <span class="kw">for</span> <span class="ident">FutureMemMap</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {}
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">OclPrm</span><span class="op">></span> <span class="ident">Sync</span> <span class="kw">for</span> <span class="ident">FutureMemMap</span><span class="op"><</span><span class="ident">T</span><span class="op">></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>