<!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 `/Users/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/ocl-0.18.0/src/async/mem_map.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>mem_map.rs.html -- source</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="../../../main.css" id="themeStyle">
<script src="../../../storage.js"></script>
</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">
<div class="sidebar-menu">☰</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">
</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>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
</pre><pre class="rust ">
<span class="comment">// use std::sync::Arc;</span>
<span class="comment">// use std::sync::atomic::AtomicBool;</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::{<span class="ident">Deref</span>, <span class="ident">DerefMut</span>};
<span class="kw">use</span> <span class="ident">core</span>::{<span class="self">self</span>, <span class="ident">OclPrm</span>, <span class="ident">ClWaitListPtr</span>, <span class="ident">ClNullEventPtr</span>, <span class="ident">MemMap</span> <span class="kw">as</span> <span class="ident">MemMapCore</span>, <span class="ident">Mem</span> <span class="kw">as</span> <span class="ident">MemCore</span>, <span class="ident">AsMem</span>};
<span class="kw">use</span> <span class="ident">standard</span>::{<span class="ident">ClWaitListPtrEnum</span>, <span class="ident">ClNullEventPtrEnum</span>, <span class="ident">Event</span>, <span class="ident">EventList</span>, <span class="ident">Queue</span>};
<span class="kw">use</span> <span class="ident">error</span>::{<span class="prelude-ty">Result</span> <span class="kw">as</span> <span class="ident">OclResult</span>};
<span class="doccomment">/// An unmap command builder.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [UNSTABLE]</span>
<span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">"commands do nothing unless enqueued"</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">MemUnmapCmd</span><span class="op"><</span><span class="lifetime">'c</span>, <span class="ident">T</span><span class="op">></span> <span class="kw">where</span> <span class="ident">T</span>: <span class="lifetime">'c</span> <span class="op">+</span> <span class="ident">OclPrm</span> {
<span class="ident">queue</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'c</span> <span class="ident">Queue</span><span class="op">></span>,
<span class="ident">mem_map</span>: <span class="kw-2">&</span><span class="lifetime">'c</span> <span class="kw-2">mut</span> <span class="ident">MemMap</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>,
<span class="ident">ewait</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">ClWaitListPtrEnum</span><span class="op"><</span><span class="lifetime">'c</span><span class="op">>></span>,
<span class="ident">enew</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">ClNullEventPtrEnum</span><span class="op"><</span><span class="lifetime">'c</span><span class="op">>></span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'c</span>, <span class="ident">T</span><span class="op">></span> <span class="ident">MemUnmapCmd</span><span class="op"><</span><span class="lifetime">'c</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="doccomment">/// Returns a new unmap command builder.</span>
<span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">mem_map</span>: <span class="kw-2">&</span><span class="lifetime">'c</span> <span class="kw-2">mut</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="ident">MemUnmapCmd</span><span class="op"><</span><span class="lifetime">'c</span>, <span class="ident">T</span><span class="op">></span>
{
<span class="ident">MemUnmapCmd</span> {
<span class="ident">queue</span>: <span class="prelude-val">None</span>,
<span class="ident">mem_map</span>: <span class="ident">mem_map</span>,
<span class="ident">ewait</span>: <span class="prelude-val">None</span>,
<span class="ident">enew</span>: <span class="prelude-val">None</span>,
}
}
<span class="doccomment">/// Specifies a queue to use for this call only.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">queue</span><span class="op"><</span><span class="lifetime">'q</span>, <span class="ident">Q</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">queue</span>: <span class="kw-2">&</span><span class="lifetime">'q</span> <span class="ident">Q</span>) <span class="op">-></span> <span class="ident">MemUnmapCmd</span><span class="op"><</span><span class="lifetime">'c</span>, <span class="ident">T</span><span class="op">></span>
<span class="kw">where</span> <span class="lifetime">'q</span>: <span class="lifetime">'c</span>, <span class="ident">Q</span>: <span class="lifetime">'q</span> <span class="op">+</span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">Queue</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">queue</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">queue</span>.<span class="ident">as_ref</span>());
<span class="self">self</span>
}
<span class="doccomment">/// Specifies an event or list of events to wait on before the command</span>
<span class="doccomment">/// will run.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// When events generated using the `::enew` method of **other**,</span>
<span class="doccomment">/// previously enqueued commands are passed here (either individually or</span>
<span class="doccomment">/// as part of an [`EventList`]), this command will not execute until</span>
<span class="doccomment">/// those commands have completed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Using events can compliment the use of queues to order commands by</span>
<span class="doccomment">/// creating temporal dependencies between them (where commands in one</span>
<span class="doccomment">/// queue must wait for the completion of commands in another). Events can</span>
<span class="doccomment">/// also supplant queues altogether when, for example, using out-of-order</span>
<span class="doccomment">/// queues.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// // Create an event list:</span>
<span class="doccomment">/// let mut event_list = EventList::new();</span>
<span class="doccomment">/// // Enqueue a kernel on `queue_1`, creating an event representing the kernel</span>
<span class="doccomment">/// // command in our list:</span>
<span class="doccomment">/// kernel.cmd().queue(&queue_1).enew(&mut event_list).enq()?;</span>
<span class="doccomment">/// // Map a buffer using `queue_2`, ensuring the read does not begin until</span>
<span class="doccomment">/// // after the kernel command has completed:</span>
<span class="doccomment">/// buffer.map().queue(&queue_2).ewait(&event_list).enq_async()?;</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`EventList`]: struct.EventList.html</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">ewait</span><span class="op"><</span><span class="ident">Ewl</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">ewait</span>: <span class="ident">Ewl</span>) <span class="op">-></span> <span class="ident">MemUnmapCmd</span><span class="op"><</span><span class="lifetime">'c</span>, <span class="ident">T</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Ewl</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">ClWaitListPtrEnum</span><span class="op"><</span><span class="lifetime">'c</span><span class="op">>></span> {
<span class="self">self</span>.<span class="ident">ewait</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">ewait</span>.<span class="ident">into</span>());
<span class="self">self</span>
}
<span class="doccomment">/// Specifies the destination to store a new, optionally created event</span>
<span class="doccomment">/// associated with this command.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The destination can be a mutable reference to an empty event (created</span>
<span class="doccomment">/// using [`Event::empty`]) or a mutable reference to an event list.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// After this command is enqueued, the event in the destination can be</span>
<span class="doccomment">/// passed to the `::ewait` method of another command. Doing so will cause</span>
<span class="doccomment">/// the other command to wait until this command has completed before</span>
<span class="doccomment">/// executing.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Using events can compliment the use of queues to order commands by</span>
<span class="doccomment">/// creating temporal dependencies between them (where commands in one</span>
<span class="doccomment">/// queue must wait for the completion of commands in another). Events can</span>
<span class="doccomment">/// also supplant queues altogether when, for example, using out-of-order</span>
<span class="doccomment">/// queues.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// // Create an event list:</span>
<span class="doccomment">/// let mut event = Event::empty();</span>
<span class="doccomment">/// // Enqueue a kernel on `queue_1`, creating an event representing the kernel</span>
<span class="doccomment">/// // command in our list:</span>
<span class="doccomment">/// kernel.cmd().queue(&queue_1).enew(&mut event).enq()?;</span>
<span class="doccomment">/// // Map a buffer using `queue_2`, ensuring the read does not begin until</span>
<span class="doccomment">/// // after the kernel command has completed:</span>
<span class="doccomment">/// buffer.map().queue(&queue_2).ewait(&event).enq_async()?;</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`Event::empty`]: struct.Event.html#method.empty</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">enew</span><span class="op"><</span><span class="ident">En</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">enew</span>: <span class="ident">En</span>) <span class="op">-></span> <span class="ident">MemUnmapCmd</span><span class="op"><</span><span class="lifetime">'c</span>, <span class="ident">T</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">En</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">ClNullEventPtrEnum</span><span class="op"><</span><span class="lifetime">'c</span><span class="op">>></span> {
<span class="self">self</span>.<span class="ident">enew</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">enew</span>.<span class="ident">into</span>());
<span class="self">self</span>
}
<span class="doccomment">/// Enqueues this command.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">enq</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span>()<span class="op">></span> {
<span class="self">self</span>.<span class="ident">mem_map</span>.<span class="ident">enqueue_unmap</span>(<span class="self">self</span>.<span class="ident">queue</span>, <span class="self">self</span>.<span class="ident">ewait</span>, <span class="self">self</span>.<span class="ident">enew</span>)
}
}
<span class="doccomment">/// A view of memory mapped by `clEnqueueMap{...}`.</span>
<span class="doccomment">///</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [UNSTABLE]: Still in a state of flux: ~90% stable</span>
<span class="doccomment">///</span>
<span class="comment">//</span>
<span class="comment">// [NOTE]: Do not derive/impl `Clone`. Will not be thread safe without a mutex.</span>
<span class="comment">//</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">MemMap</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="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">buffer</span>: <span class="ident">MemCore</span>,
<span class="ident">queue</span>: <span class="ident">Queue</span>,
<span class="ident">unmap_wait_events</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">EventList</span><span class="op">></span>,
<span class="ident">unmap_event</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Event</span><span class="op">></span>,
<span class="ident">is_unmapped</span>: <span class="ident">bool</span>,
<span class="comment">// buffer_is_mapped: Arc<AtomicBool></span>
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</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">where</span> <span class="ident">T</span>: <span class="ident">OclPrm</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">unmap_wait_events</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">EventList</span><span class="op">></span>,
<span class="ident">unmap_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="ident">MemCore</span>, <span class="ident">queue</span>: <span class="ident">Queue</span>,
<span class="comment">/*buffer_is_mapped: Arc<AtomicBool>*/</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="ident">MemMap</span> {
<span class="ident">core</span>: <span class="ident">core</span>,
<span class="ident">len</span>: <span class="ident">len</span>,
<span class="ident">buffer</span>: <span class="ident">buffer</span>,
<span class="ident">queue</span>: <span class="ident">queue</span>,
<span class="ident">unmap_wait_events</span>: <span class="ident">unmap_wait_events</span>,
<span class="ident">unmap_event</span>: <span class="ident">unmap_event</span>,
<span class="ident">is_unmapped</span>: <span class="bool-val">false</span>,
<span class="comment">// buffer_is_mapped,</span>
}
}
<span class="doccomment">/// Returns an unmap command builder.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Call `::enq` on it to enqueue the unmap command.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">unmap</span><span class="op"><</span><span class="lifetime">'c</span><span class="op">></span>(<span class="kw-2">&</span><span class="lifetime">'c</span> <span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">MemUnmapCmd</span><span class="op"><</span><span class="lifetime">'c</span>, <span class="ident">T</span><span class="op">></span> {
<span class="ident">MemUnmapCmd</span>::<span class="ident">new</span>(<span class="self">self</span>)
}
<span class="doccomment">/// Enqueues an unmap command for this memory object immediately.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Prefer `::unmap` for a more stable interface as this function may</span>
<span class="doccomment">/// change at any time.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">enqueue_unmap</span><span class="op"><</span><span class="ident">Ewl</span>, <span class="ident">En</span><span class="op">></span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">queue</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">Queue</span><span class="op">></span>, <span class="ident">ewait_opt</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Ewl</span><span class="op">></span>,
<span class="kw-2">mut</span> <span class="ident">enew_opt</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">En</span><span class="op">></span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span>()<span class="op">></span>
<span class="kw">where</span> <span class="ident">En</span>: <span class="ident">ClNullEventPtr</span>, <span class="ident">Ewl</span>: <span class="ident">ClWaitListPtr</span>
{
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">is_unmapped</span> {
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span>(<span class="ident">ewait_opt</span>.<span class="ident">is_some</span>() <span class="op">&&</span> <span class="self">self</span>.<span class="ident">unmap_wait_events</span>.<span class="ident">is_some</span>()),
<span class="string">"MemMap::enqueue_unmap: Cannot set an event wait list for the unmap command \
when the 'unmap_wait_events' has already been set."</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">origin_event_opt</span> <span class="op">=</span> <span class="kw">if</span> <span class="self">self</span>.<span class="ident">unmap_event</span>.<span class="ident">is_some</span>() <span class="op">||</span> <span class="ident">enew_opt</span>.<span class="ident">is_some</span>() {
<span class="prelude-val">Some</span>(<span class="ident">Event</span>::<span class="ident">empty</span>())
} <span class="kw">else</span> {
<span class="prelude-val">None</span>
};
<span class="ident">core</span>::<span class="ident">enqueue_unmap_mem_object</span>(<span class="ident">queue</span>.<span class="ident">unwrap_or</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">queue</span>), <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">buffer</span>,
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">core</span>, <span class="ident">ewait_opt</span>.<span class="ident">and</span>(<span class="self">self</span>.<span class="ident">unmap_wait_events</span>.<span class="ident">as_ref</span>()), <span class="ident">origin_event_opt</span>.<span class="ident">as_mut</span>())<span class="question-mark">?</span>;
<span class="self">self</span>.<span class="ident">is_unmapped</span> <span class="op">=</span> <span class="bool-val">true</span>;
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">origin_event</span>) <span class="op">=</span> <span class="ident">origin_event_opt</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="kw-2">mut</span> <span class="ident">enew</span>) <span class="op">=</span> <span class="ident">enew_opt</span> {
<span class="kw">unsafe</span> { <span class="ident">enew</span>.<span class="ident">clone_from</span>(<span class="kw-2">&</span><span class="ident">origin_event</span>) }
}
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">unmap_user_event</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">unmap_event</span>.<span class="ident">take</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">unsafe</span> { <span class="ident">origin_event</span>.<span class="ident">register_event_relay</span>(<span class="ident">unmap_user_event</span>)<span class="question-mark">?</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="ident">origin_event</span>.<span class="ident">wait_for</span>()<span class="question-mark">?</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="ident">unmap_user_event</span>.<span class="ident">set_complete</span>()<span class="question-mark">?</span>;
}
}
<span class="prelude-val">Ok</span>(())
} <span class="kw">else</span> {
<span class="prelude-val">Err</span>(<span class="string">"ocl_core::- ::unmap: Already unmapped."</span>.<span class="ident">into</span>())
}
}
<span class="doccomment">/// Returns a reference to the unmap target event if it has been set.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">unmap_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_event</span>.<span class="ident">as_ref</span>()
}
<span class="doccomment">/// Returns a reference to the unmap wait event list if it has been set.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">unmap_wait_events</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">EventList</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">unmap_wait_events</span>.<span class="ident">as_ref</span>()
}
<span class="doccomment">/// Returns true if an unmap command has already been enqueued, causing</span>
<span class="doccomment">/// the memory referenced by this `MemMap` to become invalid.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_unmapped</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">bool</span> { <span class="self">self</span>.<span class="ident">is_unmapped</span> }
<span class="doccomment">/// Returns a pointer to the host mapped memory.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_ptr</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">T</span> { <span class="self">self</span>.<span class="ident">core</span>.<span class="ident">as_ptr</span>() }
<span class="doccomment">/// Returns a mutable pointer to the host mapped memory.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_mut_ptr</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">T</span> { <span class="self">self</span>.<span class="ident">core</span>.<span class="ident">as_mut_ptr</span>() }
<span class="doccomment">/// Returns a reference to the internal core command queue.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">queue</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">Queue</span> { <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">queue</span> }
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Deref</span> <span class="kw">for</span> <span class="ident">MemMap</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="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> [<span class="ident">T</span>];
<span class="kw">fn</span> <span class="ident">deref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span>[<span class="ident">T</span>] {
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="self">self</span>.<span class="ident">is_unmapped</span>, <span class="string">"Mapped memory has been unmapped and cannot be accessed."</span>);
<span class="kw">unsafe</span> { <span class="self">self</span>.<span class="ident">core</span>.<span class="ident">as_slice</span>(<span class="self">self</span>.<span class="ident">len</span>) }
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">DerefMut</span> <span class="kw">for</span> <span class="ident">MemMap</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="kw">fn</span> <span class="ident">deref_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">T</span>] {
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="self">self</span>.<span class="ident">is_unmapped</span>, <span class="string">"Mapped memory has been unmapped and cannot be accessed."</span>);
<span class="kw">unsafe</span> { <span class="self">self</span>.<span class="ident">core</span>.<span class="ident">as_slice_mut</span>(<span class="self">self</span>.<span class="ident">len</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">Drop</span> <span class="kw">for</span> <span class="ident">MemMap</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) {
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">is_unmapped</span> {
<span class="self">self</span>.<span class="ident">enqueue_unmap</span>::<span class="op"><</span><span class="kw-2">&</span><span class="ident">Event</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">Event</span><span class="op">></span>(<span class="prelude-val">None</span>, <span class="prelude-val">None</span>, <span class="prelude-val">None</span>).<span class="ident">ok</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">AsMem</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">for</span> <span class="ident">MemMap</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">as_mem</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">MemCore</span> {
<span class="self">self</span>.<span class="ident">core</span>.<span class="ident">as_mem</span>()
}
}
<span class="comment">// impl<'a, T: OclPrm> AsMem for &'a mut MemMap<T> {</span>
<span class="comment">// fn as_mem(&self) -> &MemCore {</span>
<span class="comment">// self.core.as_mem()</span>
<span class="comment">// }</span>
<span class="comment">// }</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><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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../";
window.currentCrate = "ocl";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>