<!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/git/checkouts/ocl-21810c0a37a638dd/c345b5b/ocl/src/standard/queue.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>queue.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>
</pre><pre class="rust ">
<span class="doccomment">//! An `OpenCL` command queue.</span>
<span class="kw">use</span> <span class="ident">std</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="prelude-ty">Result</span> <span class="kw">as</span> <span class="ident">OclCoreResult</span>, <span class="ident">CommandQueue</span> <span class="kw">as</span> <span class="ident">CommandQueueCore</span>, <span class="ident">CommandQueueInfo</span>,
<span class="ident">CommandQueueInfoResult</span>, <span class="ident">OpenclVersion</span>, <span class="ident">CommandQueueProperties</span>, <span class="ident">ClWaitListPtr</span>, <span class="ident">ClContextPtr</span>};
<span class="kw">use</span> <span class="ident">error</span>::{<span class="ident">Error</span> <span class="kw">as</span> <span class="ident">OclError</span>, <span class="prelude-ty">Result</span> <span class="kw">as</span> <span class="ident">OclResult</span>};
<span class="kw">use</span> <span class="ident">standard</span>::{<span class="ident">Context</span>, <span class="ident">Device</span>, <span class="ident">Event</span>};
<span class="doccomment">/// A command queue which manages all actions taken on kernels, buffers, and</span>
<span class="doccomment">/// images.</span>
<span class="doccomment">///</span>
<span class="doccomment">///</span>
<span class="comment">//</span>
<span class="comment">// * TODO: Consider implementing a constructor which accepts a DeviceIdCore and</span>
<span class="comment">// creates a context and queue from it.</span>
<span class="comment">//</span>
<span class="comment">//</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Queue</span> {
<span class="ident">obj_core</span>: <span class="ident">CommandQueueCore</span>,
<span class="ident">device_version</span>: <span class="ident">OpenclVersion</span>,
}
<span class="kw">impl</span> <span class="ident">Queue</span> {
<span class="doccomment">/// Returns a new Queue on the device specified by `device`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">context</span>: <span class="kw-2">&</span><span class="ident">Context</span>, <span class="ident">device</span>: <span class="ident">Device</span>, <span class="ident">properties</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">CommandQueueProperties</span><span class="op">></span>)
<span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Queue</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">obj_core</span> <span class="op">=</span> <span class="ident">core</span>::<span class="ident">create_command_queue</span>(<span class="ident">context</span>, <span class="kw-2">&</span><span class="ident">device</span>, <span class="ident">properties</span>)<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">device_version</span> <span class="op">=</span> <span class="ident">device</span>.<span class="ident">version</span>()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="ident">Queue</span> {
<span class="ident">obj_core</span>: <span class="ident">obj_core</span>,
<span class="ident">device_version</span>: <span class="ident">device_version</span>,
})
}
<span class="doccomment">/// Issues all previously queued OpenCL commands to the device.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">flush</span>(<span class="kw-2">&</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="ident">core</span>::<span class="ident">flush</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">obj_core</span>).<span class="ident">map_err</span>(<span class="ident">OclError</span>::<span class="ident">from</span>)
}
<span class="doccomment">/// Blocks until all commands in this queue have completed before returning.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">finish</span>(<span class="kw-2">&</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="ident">core</span>::<span class="ident">finish</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">obj_core</span>).<span class="ident">map_err</span>(<span class="ident">OclError</span>::<span class="ident">from</span>)
}
<span class="doccomment">/// Enqueues a marker command which waits for either a list of events to</span>
<span class="doccomment">/// complete, or all previously enqueued commands to complete.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">enqueue_marker</span><span class="op"><</span><span class="ident">Ewl</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">ewait</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Ewl</span><span class="op">></span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Event</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Ewl</span>: <span class="ident">ClWaitListPtr</span>
{
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">marker_event</span> <span class="op">=</span> <span class="ident">Event</span>::<span class="ident">empty</span>();
<span class="ident">core</span>::<span class="ident">enqueue_marker_with_wait_list</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">obj_core</span>, <span class="ident">ewait</span>, <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">marker_event</span>),
<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">device_version</span>)).<span class="ident">map</span>(<span class="op">|</span>_<span class="op">|</span> <span class="ident">marker_event</span>)
.<span class="ident">map_err</span>(<span class="ident">OclError</span>::<span class="ident">from</span>)
}
<span class="doccomment">/// Returns a reference to the core pointer wrapper, usable by functions in</span>
<span class="doccomment">/// the `core` module.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_core</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">CommandQueueCore</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">obj_core</span>
}
<span class="doccomment">/// Returns a copy of the Context associated with this queue.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">context</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">Context</span> {
<span class="self">self</span>.<span class="ident">obj_core</span>.<span class="ident">context</span>().<span class="ident">map</span>(<span class="ident">Context</span>::<span class="ident">from</span>).<span class="ident">unwrap</span>()
}
<span class="doccomment">/// Returns the `OpenCL` device associated with this queue.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">device</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">Device</span> {
<span class="self">self</span>.<span class="ident">obj_core</span>.<span class="ident">device</span>().<span class="ident">map</span>(<span class="ident">Device</span>::<span class="ident">from</span>).<span class="ident">unwrap</span>()
}
<span class="doccomment">/// Returns the cached device version.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">device_version</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">OpenclVersion</span> {
<span class="self">self</span>.<span class="ident">device_version</span>
}
<span class="doccomment">/// Returns info about this queue.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">info</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">info_kind</span>: <span class="ident">CommandQueueInfo</span>) <span class="op">-></span> <span class="ident">OclCoreResult</span><span class="op"><</span><span class="ident">CommandQueueInfoResult</span><span class="op">></span> {
<span class="ident">core</span>::<span class="ident">get_command_queue_info</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">obj_core</span>, <span class="ident">info_kind</span>)
}
<span class="kw">fn</span> <span class="ident">fmt_info</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="ident">f</span>.<span class="ident">debug_struct</span>(<span class="string">"Queue"</span>)
.<span class="ident">field</span>(<span class="string">"Context"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">CommandQueueInfo</span>::<span class="ident">Context</span>))
.<span class="ident">field</span>(<span class="string">"Device"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">CommandQueueInfo</span>::<span class="ident">Device</span>))
.<span class="ident">field</span>(<span class="string">"ReferenceCount"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">CommandQueueInfo</span>::<span class="ident">ReferenceCount</span>))
.<span class="ident">field</span>(<span class="string">"Properties"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">CommandQueueInfo</span>::<span class="ident">Properties</span>))
.<span class="ident">finish</span>()
}
}
<span class="kw">impl</span> <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">Queue</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="self">self</span>.<span class="ident">fmt_info</span>(<span class="ident">f</span>)
}
}
<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">Queue</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Queue</span> {
<span class="kw">fn</span> <span class="ident">as_ref</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="self">self</span>
}
}
<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">CommandQueueCore</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Queue</span> {
<span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">CommandQueueCore</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">obj_core</span>
}
}
<span class="kw">impl</span> <span class="ident">Deref</span> <span class="kw">for</span> <span class="ident">Queue</span> {
<span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">CommandQueueCore</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">CommandQueueCore</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">obj_core</span>
}
}
<span class="kw">impl</span> <span class="ident">DerefMut</span> <span class="kw">for</span> <span class="ident">Queue</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">CommandQueueCore</span> {
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">obj_core</span>
}
}
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">ClContextPtr</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Queue</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="ident">ffi</span>::<span class="ident">cl_context</span> {
<span class="self">self</span>.<span class="ident">context_ptr</span>().<span class="ident">expect</span>(<span class="string">"<&Queue as ClContextPtr>::as_ptr: \
Unable to obtain a context pointer."</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>