<!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\standard\device.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>device.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>
<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>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
<span id="565">565</span>
<span id="566">566</span>
<span id="567">567</span>
<span id="568">568</span>
<span id="569">569</span>
<span id="570">570</span>
<span id="571">571</span>
<span id="572">572</span>
<span id="573">573</span>
</pre><pre class="rust ">
<span class="doccomment">//! An OpenCL device identifier and related types.</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">std</span>::<span class="ident">borrow</span>::<span class="ident">Borrow</span>;
<span class="kw">use</span> <span class="ident">core</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">Platform</span>;
<span class="kw">use</span> <span class="ident">ffi</span>::<span class="ident">cl_device_id</span>;
<span class="kw">use</span> <span class="ident">core</span>::{<span class="self">self</span>, <span class="ident">DeviceId</span> <span class="kw">as</span> <span class="ident">DeviceIdCore</span>, <span class="ident">DeviceType</span>, <span class="ident">DeviceInfo</span>, <span class="ident">DeviceInfoResult</span>, <span class="ident">ClDeviceIdPtr</span>};
<span class="kw">use</span> <span class="ident">core</span>::<span class="ident">util</span>;
<span class="comment">// Perhaps add something like this to the `DeviceSpecifier`.</span>
<span class="comment">//</span>
<span class="comment">// Copied from `https://github.com/TyOverby/ocl-repro/blob/master/src/main.rs`:</span>
<span class="comment">//</span>
<span class="comment">// pub fn first_gpu() -> (Platform, Device) {</span>
<span class="comment">// let mut out = vec![];</span>
<span class="comment">// for plat in Platform::list() {</span>
<span class="comment">// if let Ok(all_devices) = Device::list_all(&plat) {</span>
<span class="comment">// for dev in all_devices {</span>
<span class="comment">// out.push((plat.clone(), dev));</span>
<span class="comment">// }</span>
<span class="comment">// }</span>
<span class="comment">// }</span>
<span class="comment">//</span>
<span class="comment">// // Prefer GPU</span>
<span class="comment">// out.sort_by(|&(_, ref a), &(_, ref b)| {</span>
<span class="comment">// let a_type = a.info(DeviceInfo::Type);</span>
<span class="comment">// let b_type = b.info(DeviceInfo::Type);</span>
<span class="comment">// if let (DeviceInfoResult::Type(a_type), DeviceInfoResult::Type(b_type)) = (a_type, b_type) {</span>
<span class="comment">// b_type.cmp(&a_type)</span>
<span class="comment">// } else {</span>
<span class="comment">// (0).cmp(&0)</span>
<span class="comment">// }</span>
<span class="comment">// });</span>
<span class="comment">//</span>
<span class="comment">// out.first().unwrap().clone()</span>
<span class="comment">// }</span>
<span class="doccomment">/// Specifies [what boils down to] a list of devices.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The `Indices` variant is context-specific, not robust, and may lead to a</span>
<span class="doccomment">/// panic if the context changes. It is useful for convenience only and not</span>
<span class="doccomment">/// recommended for general use. The `WrappingIndices` variant is somewhat</span>
<span class="doccomment">/// less dangerous but can still be somewhat machine-specific.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The `TypeFlags` variant is used for specifying a list of devices using a</span>
<span class="doccomment">/// bitfield (`DeviceType`) and is the most robust / portable.</span>
<span class="doccomment">///</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [FIXME: Add some links to the SDK]</span>
<span class="doccomment">///</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">All</span>,
<span class="ident">First</span>,
<span class="ident">Single</span>(<span class="ident">Device</span>),
<span class="ident">List</span>(<span class="ident">Vec</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>),
<span class="ident">Indices</span>(<span class="ident">Vec</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>),
<span class="ident">WrappingIndices</span>(<span class="ident">Vec</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>),
<span class="ident">TypeFlags</span>(<span class="ident">DeviceType</span>),
}
<span class="kw">impl</span> <span class="ident">DeviceSpecifier</span> {
<span class="doccomment">/// Returns a `DeviceSpecifier::All` variant which specifies all</span>
<span class="doccomment">/// devices on a platform.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">all</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">All</span>
}
<span class="doccomment">/// Returns a `DeviceSpecifier::First` variant which specifies only</span>
<span class="doccomment">/// the first device on a platform.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">first</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">First</span>
}
<span class="doccomment">/// Returns a `DeviceSpecifier::Single` variant which specifies a single</span>
<span class="doccomment">/// device.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">single</span>(<span class="self">self</span>, <span class="ident">device</span>: <span class="ident">Device</span>) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">Single</span>(<span class="ident">device</span>)
}
<span class="doccomment">/// Returns a `DeviceSpecifier::List` variant which specifies a list of</span>
<span class="doccomment">/// devices.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">list</span>(<span class="self">self</span>, <span class="ident">list</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">List</span>(<span class="ident">list</span>)
}
<span class="doccomment">/// Returns a `DeviceSpecifier::Indices` variant which specifies a list of</span>
<span class="doccomment">/// devices by index.</span>
<span class="doccomment">///</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ### Safety</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This variant is context-specific, not robust, and may lead to a panic</span>
<span class="doccomment">/// if the context changes. It is useful for convenience only and not</span>
<span class="doccomment">/// recommended for general use.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Though using the `Indices` variant is not strictly unsafe in the usual</span>
<span class="doccomment">/// way (will not lead to memory bugs, etc.), it is marked unsafe as a</span>
<span class="doccomment">/// warning. Recommendations for a more idiomatic way to express this</span>
<span class="doccomment">/// potential footgun are welcome.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Using `::wrapping_indices` is a more robust (but still potentially</span>
<span class="doccomment">/// non-portable) solution.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">indices</span>(<span class="self">self</span>, <span class="ident">indices</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">Indices</span>(<span class="ident">indices</span>)
}
<span class="doccomment">/// Returns a `DeviceSpecifier::WrappingIndices` variant, specifying a</span>
<span class="doccomment">/// list of devices by indices which are wrapped around (simply using the</span>
<span class="doccomment">/// modulo operator) so that every index is always valid.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">wrapping_indices</span>(<span class="self">self</span>, <span class="ident">windices</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">WrappingIndices</span>(<span class="ident">windices</span>)
}
<span class="doccomment">/// Returns a `DeviceSpecifier::TypeFlags` variant which specifies a list</span>
<span class="doccomment">/// of devices using a conventional bitfield.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">type_flags</span>(<span class="self">self</span>, <span class="ident">flags</span>: <span class="ident">DeviceType</span>) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">TypeFlags</span>(<span class="ident">flags</span>)
}
<span class="doccomment">/// Returns the list of devices matching the parameters specified by this</span>
<span class="doccomment">/// `DeviceSpecifier`</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ### Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Any device indices listed within the `Indices` variant must be within</span>
<span class="doccomment">/// the range of the number of devices for the platform specified by</span>
<span class="doccomment">/// `Platform`. If no `platform` has been specified, this behaviour is</span>
<span class="doccomment">/// undefined and could end up using any platform at all.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_device_list</span><span class="op"><</span><span class="ident">P</span>: <span class="ident">Borrow</span><span class="op"><</span><span class="ident">Platform</span><span class="op">>></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">platform</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">P</span><span class="op">></span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">Device</span><span class="op">>></span> {
<span class="comment">// let platform = match platform {</span>
<span class="comment">// Some(p) => p.clone(),</span>
<span class="comment">// None => Platform::default(),</span>
<span class="comment">// };</span>
<span class="comment">// let platform = platform.unwrap_or(Platform::default());</span>
<span class="kw">let</span> <span class="ident">platform</span> <span class="op">=</span> <span class="ident">platform</span>.<span class="ident">map</span>(<span class="op">|</span><span class="ident">p</span><span class="op">|</span> <span class="ident">p</span>.<span class="ident">borrow</span>().<span class="ident">clone</span>()).<span class="ident">unwrap_or</span>(<span class="ident">Platform</span>::<span class="ident">default</span>());
<span class="kw">match</span> <span class="kw-2">*</span><span class="self">self</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">All</span> <span class="op">=></span> {
<span class="ident">Device</span>::<span class="ident">list_all</span>(<span class="kw-2">&</span><span class="ident">platform</span>)
},
<span class="ident">DeviceSpecifier</span>::<span class="ident">First</span> <span class="op">=></span> {
<span class="ident">Device</span>::<span class="ident">list_select</span>(<span class="kw-2">&</span><span class="ident">platform</span>, <span class="prelude-val">None</span>, <span class="kw-2">&</span>[<span class="number">0</span>])
},
<span class="ident">DeviceSpecifier</span>::<span class="ident">Single</span>(<span class="kw-2">ref</span> <span class="ident">device</span>) <span class="op">=></span> {
<span class="prelude-val">Ok</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="ident">device</span>.<span class="ident">clone</span>()])
},
<span class="ident">DeviceSpecifier</span>::<span class="ident">List</span>(<span class="kw-2">ref</span> <span class="ident">devices</span>) <span class="op">=></span> {
<span class="prelude-val">Ok</span>(<span class="ident">devices</span>.<span class="ident">clone</span>())
},
<span class="ident">DeviceSpecifier</span>::<span class="ident">Indices</span>(<span class="kw-2">ref</span> <span class="ident">idx_list</span>) <span class="op">=></span> {
<span class="ident">Device</span>::<span class="ident">list_select</span>(<span class="kw-2">&</span><span class="ident">platform</span>, <span class="prelude-val">None</span>, <span class="ident">idx_list</span>)
},
<span class="ident">DeviceSpecifier</span>::<span class="ident">WrappingIndices</span>(<span class="kw-2">ref</span> <span class="ident">idx_list</span>) <span class="op">=></span> {
<span class="ident">Device</span>::<span class="ident">list_select_wrap</span>(<span class="kw-2">&</span><span class="ident">platform</span>, <span class="prelude-val">None</span>, <span class="ident">idx_list</span>)
},
<span class="ident">DeviceSpecifier</span>::<span class="ident">TypeFlags</span>(<span class="ident">flags</span>) <span class="op">=></span> {
<span class="ident">Device</span>::<span class="ident">list</span>(<span class="kw-2">&</span><span class="ident">platform</span>, <span class="prelude-val">Some</span>(<span class="ident">flags</span>))
},
}
}
}
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">DeviceSpecifier</span> {
<span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">All</span>
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> <span class="kw">for</span> <span class="ident">DeviceSpecifier</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">index</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">WrappingIndices</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="ident">index</span>])
}
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">usize</span>]<span class="op">></span> <span class="kw">for</span> <span class="ident">DeviceSpecifier</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">indices</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">usize</span>]) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">WrappingIndices</span>(<span class="ident">indices</span>.<span class="ident">into</span>())
}
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">usize</span><span class="op">>></span> <span class="kw">for</span> <span class="ident">DeviceSpecifier</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">indices</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">WrappingIndices</span>(<span class="ident">indices</span>.<span class="ident">clone</span>())
}
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">Device</span>]<span class="op">></span> <span class="kw">for</span> <span class="ident">DeviceSpecifier</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">devices</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">Device</span>]) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">List</span>(<span class="ident">devices</span>.<span class="ident">into</span>())
}
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">Device</span><span class="op">>></span> <span class="kw">for</span> <span class="ident">DeviceSpecifier</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">devices</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">List</span>(<span class="ident">devices</span>.<span class="ident">clone</span>())
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span> <span class="kw">for</span> <span class="ident">DeviceSpecifier</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">device</span>: <span class="ident">Device</span>) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">Single</span>(<span class="ident">device</span>)
}
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Device</span><span class="op">></span> <span class="kw">for</span> <span class="ident">DeviceSpecifier</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">device</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Device</span>) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">Single</span>(<span class="ident">device</span>.<span class="ident">clone</span>())
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">DeviceType</span><span class="op">></span> <span class="kw">for</span> <span class="ident">DeviceSpecifier</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">flags</span>: <span class="ident">DeviceType</span>) <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">TypeFlags</span>(<span class="ident">flags</span>)
}
}
<span class="doccomment">/// An individual device identifier (an OpenCL device_id).</span>
<span class="doccomment">///</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>)]</span>
<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Device</span>(<span class="ident">DeviceIdCore</span>);
<span class="kw">impl</span> <span class="ident">Device</span> {
<span class="doccomment">/// Returns the first available device on a platform.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Panics upon OpenCL error.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">first</span><span class="op"><</span><span class="ident">P</span>: <span class="ident">Borrow</span><span class="op"><</span><span class="ident">Platform</span><span class="op">>></span>(<span class="ident">platform</span>: <span class="ident">P</span>) <span class="op">-></span> <span class="ident">Device</span> {
<span class="kw">let</span> <span class="ident">device_ids</span> <span class="op">=</span> <span class="ident">core</span>::<span class="ident">get_device_ids</span>(<span class="ident">platform</span>.<span class="ident">borrow</span>(), <span class="prelude-val">None</span>, <span class="prelude-val">None</span>)
.<span class="ident">expect</span>(<span class="string">"ocl::Device::first: Error retrieving device list"</span>);
<span class="ident">Device</span>(<span class="ident">device_ids</span>[<span class="number">0</span>])
}
<span class="doccomment">/// Returns a single device specified by a wrapped index.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Panics upon OpenCL error.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">by_idx_wrap</span><span class="op"><</span><span class="ident">P</span>: <span class="ident">Borrow</span><span class="op"><</span><span class="ident">Platform</span><span class="op">>></span>(<span class="ident">platform</span>: <span class="ident">P</span>, <span class="ident">device_idx_wrap</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">Device</span> {
<span class="kw">let</span> <span class="ident">device_ids</span> <span class="op">=</span> <span class="ident">core</span>::<span class="ident">get_device_ids</span>(<span class="ident">platform</span>.<span class="ident">borrow</span>(), <span class="prelude-val">None</span>, <span class="prelude-val">None</span>)
.<span class="ident">expect</span>(<span class="string">"ocl::Device::by_idx_wrap: Error retrieving device list"</span>);
<span class="kw">let</span> <span class="ident">wrapped_idx</span> <span class="op">=</span> <span class="ident">device_idx_wrap</span> <span class="op">%</span> <span class="ident">device_ids</span>.<span class="ident">len</span>();
<span class="ident">Device</span>(<span class="ident">device_ids</span>[<span class="ident">wrapped_idx</span>])
}
<span class="doccomment">/// Returns a `DeviceSpecifier` useful for precisely specifying a set</span>
<span class="doccomment">/// of devices.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">specifier</span>() <span class="op">-></span> <span class="ident">DeviceSpecifier</span> {
<span class="ident">DeviceSpecifier</span>::<span class="ident">default</span>()
}
<span class="doccomment">/// Resolves a list of indices into a list of valid devices.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// `devices` is the set of all indexable devices.</span>
<span class="doccomment">///</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ### Errors</span>
<span class="doccomment">///</span>
<span class="doccomment">/// All indices in `idxs` must be valid. Use `resolve_idxs_wrap` for index</span>
<span class="doccomment">/// lists which may contain out of bounds indices.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">resolve_idxs</span>(<span class="ident">idxs</span>: <span class="kw-2">&</span>[<span class="ident">usize</span>], <span class="ident">devices</span>: <span class="kw-2">&</span>[<span class="ident">Device</span>]) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">Device</span><span class="op">>></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="ident">idxs</span>.<span class="ident">len</span>());
<span class="kw">for</span> <span class="kw-2">&</span><span class="ident">idx</span> <span class="kw">in</span> <span class="ident">idxs</span>.<span class="ident">iter</span>() {
<span class="kw">match</span> <span class="ident">devices</span>.<span class="ident">get</span>(<span class="ident">idx</span>) {
<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="ident">device</span>) <span class="op">=></span> <span class="ident">result</span>.<span class="ident">push</span>(<span class="ident">device</span>),
<span class="prelude-val">None</span> <span class="op">=></span> <span class="kw">return</span> <span class="ident">OclError</span>::<span class="ident">err_string</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"Error resolving device index: '{}'. Index out of \
range. Devices avaliable: '{}'."</span>, <span class="ident">idx</span>, <span class="ident">devices</span>.<span class="ident">len</span>())),
}
}
<span class="prelude-val">Ok</span>(<span class="ident">result</span>)
}
<span class="doccomment">/// Resolves a list of indices into a list of valid devices.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// `devices` is the set of all indexable devices.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Wraps indices around using modulo (`%`) so that every index is valid.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">resolve_idxs_wrap</span>(<span class="ident">idxs</span>: <span class="kw-2">&</span>[<span class="ident">usize</span>], <span class="ident">devices</span>: <span class="kw-2">&</span>[<span class="ident">Device</span>]) <span class="op">-></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">valid_idxs</span> <span class="op">=</span> <span class="ident">util</span>::<span class="ident">wrap_vals</span>(<span class="ident">idxs</span>, <span class="ident">devices</span>.<span class="ident">len</span>());
<span class="ident">valid_idxs</span>.<span class="ident">iter</span>().<span class="ident">map</span>(<span class="op">|</span><span class="kw-2">&</span><span class="ident">idx</span><span class="op">|</span> <span class="ident">devices</span>[<span class="ident">idx</span>]).<span class="ident">collect</span>()
}
<span class="doccomment">/// Returns a list of all devices avaliable for a given platform which</span>
<span class="doccomment">/// optionally match the flags set in the bitfield, `device_types`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Setting `device_types` to `None` will return a list of all avaliable</span>
<span class="doccomment">/// devices for `platform` regardless of type.</span>
<span class="doccomment">///</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ### Errors</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns an `Err(ocl::core::Error::Status {...})` enum variant upon any</span>
<span class="doccomment">/// OpenCL error. Calling [`.status()`] on the returned error will return</span>
<span class="doccomment">/// an `Option(``[ocl::core::Status]``)` which can be unwrapped then</span>
<span class="doccomment">/// matched to determine the precise reason for failure.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`.status()`]: enum.Error.html#method.status</span>
<span class="doccomment">/// [`ocl::core::Status`]: enum.Status.html</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">list</span><span class="op"><</span><span class="ident">P</span>: <span class="ident">Borrow</span><span class="op"><</span><span class="ident">Platform</span><span class="op">>></span>(<span class="ident">platform</span>: <span class="ident">P</span>, <span class="ident">device_types</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">DeviceType</span><span class="op">></span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">Device</span><span class="op">>></span> {
<span class="kw">let</span> <span class="ident">list_core</span> <span class="op">=</span> <span class="ident">core</span>::<span class="ident">get_device_ids</span>(<span class="ident">platform</span>.<span class="ident">borrow</span>(), <span class="ident">device_types</span>, <span class="prelude-val">None</span>)
.<span class="ident">unwrap_or</span>(<span class="macro">vec</span><span class="macro">!</span>[]);
<span class="prelude-val">Ok</span>(<span class="ident">list_core</span>.<span class="ident">into_iter</span>().<span class="ident">map</span>(<span class="ident">Device</span>).<span class="ident">collect</span>())
}
<span class="doccomment">/// Returns a list of all devices avaliable for a given `platform`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Equivalent to `::list(platform, None)`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See [`::list`](struct.Device.html#method.list) for other</span>
<span class="doccomment">/// error information.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">list_all</span><span class="op"><</span><span class="ident">P</span>: <span class="ident">Borrow</span><span class="op"><</span><span class="ident">Platform</span><span class="op">>></span>(<span class="ident">platform</span>: <span class="ident">P</span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">Device</span><span class="op">>></span> {
<span class="self">Self</span>::<span class="ident">list</span>(<span class="ident">platform</span>, <span class="prelude-val">None</span>)
}
<span class="doccomment">/// Returns a list of devices filtered by type then selected using a</span>
<span class="doccomment">/// list of indices.</span>
<span class="doccomment">///</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ### Errors</span>
<span class="doccomment">///</span>
<span class="doccomment">/// All indices in `idxs` must be valid.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See [`::list`](struct.Device.html#method.list) for other</span>
<span class="doccomment">/// error information.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">list_select</span><span class="op"><</span><span class="ident">P</span>: <span class="ident">Borrow</span><span class="op"><</span><span class="ident">Platform</span><span class="op">>></span>(<span class="ident">platform</span>: <span class="ident">P</span>, <span class="ident">device_types</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">DeviceType</span><span class="op">></span>,
<span class="ident">idxs</span>: <span class="kw-2">&</span>[<span class="ident">usize</span>]) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">Device</span><span class="op">>></span> {
<span class="self">Self</span>::<span class="ident">resolve_idxs</span>(<span class="ident">idxs</span>, <span class="kw-2">&</span><span class="macro">try</span><span class="macro">!</span>(<span class="self">Self</span>::<span class="ident">list</span>(<span class="ident">platform</span>, <span class="ident">device_types</span>)))
}
<span class="doccomment">/// Returns a list of devices filtered by type then selected using a</span>
<span class="doccomment">/// wrapping list of indices.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Wraps indices around (`%`) so that every index is valid.</span>
<span class="doccomment">///</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ### Errors</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See [`::list`](struct.Device.html#method.list)</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">list_select_wrap</span><span class="op"><</span><span class="ident">P</span>: <span class="ident">Borrow</span><span class="op"><</span><span class="ident">Platform</span><span class="op">>></span>(<span class="ident">platform</span>: <span class="ident">P</span>, <span class="ident">device_types</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">DeviceType</span><span class="op">></span>,
<span class="ident">idxs</span>: <span class="kw-2">&</span>[<span class="ident">usize</span>]) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">Device</span><span class="op">>></span> {
<span class="prelude-val">Ok</span>(<span class="self">Self</span>::<span class="ident">resolve_idxs_wrap</span>(<span class="ident">idxs</span>, <span class="kw-2">&</span><span class="macro">try</span><span class="macro">!</span>(<span class="self">Self</span>::<span class="ident">list</span>(<span class="ident">platform</span>, <span class="ident">device_types</span>))))
}
<span class="doccomment">/// Returns a list of `Device`s from a list of `DeviceIdCore`s</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">list_from_core</span>(<span class="kw-2">mut</span> <span class="ident">devices</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">DeviceIdCore</span><span class="op">></span>) <span class="op">-></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span> {
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">mem</span>;
<span class="macro">debug_assert</span><span class="macro">!</span>(<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="ident">DeviceIdCore</span><span class="op">></span>() <span class="op">==</span> <span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="ident">Device</span><span class="op">></span>());
<span class="kw">unsafe</span> {
<span class="kw">let</span> (<span class="ident">ptr</span>, <span class="ident">len</span>, <span class="ident">cap</span>) <span class="op">=</span> (<span class="ident">devices</span>.<span class="ident">as_mut_ptr</span>(), <span class="ident">devices</span>.<span class="ident">len</span>(), <span class="ident">devices</span>.<span class="ident">capacity</span>());
<span class="ident">mem</span>::<span class="ident">forget</span>(<span class="ident">devices</span>);
<span class="ident">Vec</span>::<span class="ident">from_raw_parts</span>(<span class="ident">ptr</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">Device</span>, <span class="ident">len</span>, <span class="ident">cap</span>)
}
}
<span class="doccomment">/// Returns the device name.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">name</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">String</span> {
<span class="ident">core</span>::<span class="ident">get_device_info</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>, <span class="ident">DeviceInfo</span>::<span class="ident">Name</span>).<span class="ident">into</span>()
}
<span class="doccomment">/// Returns the device vendor as a string.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">vendor</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">String</span> {
<span class="ident">core</span>::<span class="ident">get_device_info</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>, <span class="ident">DeviceInfo</span>::<span class="ident">Vendor</span>).<span class="ident">into</span>()
}
<span class="doccomment">/// Returns the maximum workgroup size or an error.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">max_wg_size</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="ident">usize</span><span class="op">></span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MaxWorkGroupSize</span>) {
<span class="ident">DeviceInfoResult</span>::<span class="ident">MaxWorkGroupSize</span>(<span class="ident">r</span>) <span class="op">=></span> <span class="prelude-val">Ok</span>(<span class="ident">r</span>),
<span class="ident">DeviceInfoResult</span>::<span class="ident">Error</span>(<span class="ident">err</span>) <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="kw-2">*</span><span class="ident">err</span>),
_ <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Device::max_wg_size: Unexpected 'DeviceInfoResult' variant."</span>),
}
}
<span class="doccomment">/// Returns the memory base address alignment offset or an error.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">mem_base_addr_align</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="ident">u32</span><span class="op">></span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MemBaseAddrAlign</span>) {
<span class="ident">DeviceInfoResult</span>::<span class="ident">MemBaseAddrAlign</span>(<span class="ident">r</span>) <span class="op">=></span> <span class="prelude-val">Ok</span>(<span class="ident">r</span>),
<span class="ident">DeviceInfoResult</span>::<span class="ident">Error</span>(<span class="ident">err</span>) <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="kw-2">*</span><span class="ident">err</span>),
_ <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Device::mem_base_addr_align: Unexpected 'DeviceInfoResult' variant."</span>),
}
}
<span class="doccomment">/// Returns whether or not the device is available for use.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_available</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="ident">bool</span><span class="op">></span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">Available</span>) {
<span class="ident">DeviceInfoResult</span>::<span class="ident">Available</span>(<span class="ident">r</span>) <span class="op">=></span> <span class="prelude-val">Ok</span>(<span class="ident">r</span>),
<span class="ident">DeviceInfoResult</span>::<span class="ident">Error</span>(<span class="ident">err</span>) <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="kw-2">*</span><span class="ident">err</span>),
_ <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Device::is_available: Unexpected 'DeviceInfoResult' variant."</span>),
}
}
<span class="doccomment">/// Returns info about the device.</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">DeviceInfo</span>) <span class="op">-></span> <span class="ident">DeviceInfoResult</span> {
<span class="ident">core</span>::<span class="ident">get_device_info</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>, <span class="ident">info_kind</span>)
}
<span class="doccomment">/// Returns a string containing a formatted list of device properties.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_string</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">String</span> {
<span class="self">self</span>.<span class="ident">clone</span>().<span class="ident">into</span>()
}
<span class="doccomment">/// Returns the underlying `DeviceIdCore`.</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">DeviceIdCore</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</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">"Device"</span>)
.<span class="ident">field</span>(<span class="string">"Type"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">Type</span>))
.<span class="ident">field</span>(<span class="string">"VendorId"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">VendorId</span>))
.<span class="ident">field</span>(<span class="string">"MaxComputeUnits"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MaxComputeUnits</span>))
.<span class="ident">field</span>(<span class="string">"MaxWorkItemDimensions"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MaxWorkItemDimensions</span>))
.<span class="ident">field</span>(<span class="string">"MaxWorkGroupSize"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MaxWorkGroupSize</span>))
.<span class="ident">field</span>(<span class="string">"MaxWorkItemSizes"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MaxWorkItemSizes</span>))
.<span class="ident">field</span>(<span class="string">"PreferredVectorWidthChar"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">PreferredVectorWidthChar</span>))
.<span class="ident">field</span>(<span class="string">"PreferredVectorWidthShort"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">PreferredVectorWidthShort</span>))
.<span class="ident">field</span>(<span class="string">"PreferredVectorWidthInt"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">PreferredVectorWidthInt</span>))
.<span class="ident">field</span>(<span class="string">"PreferredVectorWidthLong"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">PreferredVectorWidthLong</span>))
.<span class="ident">field</span>(<span class="string">"PreferredVectorWidthFloat"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">PreferredVectorWidthFloat</span>))
.<span class="ident">field</span>(<span class="string">"PreferredVectorWidthDouble"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">PreferredVectorWidthDouble</span>))
.<span class="ident">field</span>(<span class="string">"MaxClockFrequency"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MaxClockFrequency</span>))
.<span class="ident">field</span>(<span class="string">"AddressBits"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">AddressBits</span>))
.<span class="ident">field</span>(<span class="string">"MaxReadImageArgs"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MaxReadImageArgs</span>))
.<span class="ident">field</span>(<span class="string">"MaxWriteImageArgs"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MaxWriteImageArgs</span>))
.<span class="ident">field</span>(<span class="string">"MaxMemAllocSize"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MaxMemAllocSize</span>))
.<span class="ident">field</span>(<span class="string">"Image2dMaxWidth"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">Image2dMaxWidth</span>))
.<span class="ident">field</span>(<span class="string">"Image2dMaxHeight"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">Image2dMaxHeight</span>))
.<span class="ident">field</span>(<span class="string">"Image3dMaxWidth"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">Image3dMaxWidth</span>))
.<span class="ident">field</span>(<span class="string">"Image3dMaxHeight"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">Image3dMaxHeight</span>))
.<span class="ident">field</span>(<span class="string">"Image3dMaxDepth"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">Image3dMaxDepth</span>))
.<span class="ident">field</span>(<span class="string">"ImageSupport"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">ImageSupport</span>))
.<span class="ident">field</span>(<span class="string">"MaxParameterSize"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MaxParameterSize</span>))
.<span class="ident">field</span>(<span class="string">"MaxSamplers"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MaxSamplers</span>))
.<span class="ident">field</span>(<span class="string">"MemBaseAddrAlign"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MemBaseAddrAlign</span>))
.<span class="ident">field</span>(<span class="string">"MinDataTypeAlignSize"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MinDataTypeAlignSize</span>))
.<span class="ident">field</span>(<span class="string">"SingleFpConfig"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">SingleFpConfig</span>))
.<span class="ident">field</span>(<span class="string">"GlobalMemCacheType"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">GlobalMemCacheType</span>))
.<span class="ident">field</span>(<span class="string">"GlobalMemCachelineSize"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">GlobalMemCachelineSize</span>))
.<span class="ident">field</span>(<span class="string">"GlobalMemCacheSize"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">GlobalMemCacheSize</span>))
.<span class="ident">field</span>(<span class="string">"GlobalMemSize"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">GlobalMemSize</span>))
.<span class="ident">field</span>(<span class="string">"MaxConstantBufferSize"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MaxConstantBufferSize</span>))
.<span class="ident">field</span>(<span class="string">"MaxConstantArgs"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">MaxConstantArgs</span>))
.<span class="ident">field</span>(<span class="string">"LocalMemType"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">LocalMemType</span>))
.<span class="ident">field</span>(<span class="string">"LocalMemSize"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">LocalMemSize</span>))
.<span class="ident">field</span>(<span class="string">"ErrorCorrectionSupport"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">ErrorCorrectionSupport</span>))
.<span class="ident">field</span>(<span class="string">"ProfilingTimerResolution"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">ProfilingTimerResolution</span>))
.<span class="ident">field</span>(<span class="string">"EndianLittle"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">EndianLittle</span>))
.<span class="ident">field</span>(<span class="string">"Available"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">Available</span>))
.<span class="ident">field</span>(<span class="string">"CompilerAvailable"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">CompilerAvailable</span>))
.<span class="ident">field</span>(<span class="string">"ExecutionCapabilities"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">ExecutionCapabilities</span>))
.<span class="ident">field</span>(<span class="string">"QueueProperties"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">QueueProperties</span>))
.<span class="ident">field</span>(<span class="string">"Name"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">Name</span>))
.<span class="ident">field</span>(<span class="string">"Vendor"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">Vendor</span>))
.<span class="ident">field</span>(<span class="string">"DriverVersion"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">DriverVersion</span>))
.<span class="ident">field</span>(<span class="string">"Profile"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">Profile</span>))
.<span class="ident">field</span>(<span class="string">"Version"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">Version</span>))
.<span class="ident">field</span>(<span class="string">"Extensions"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">Extensions</span>))
.<span class="ident">field</span>(<span class="string">"Platform"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">Platform</span>))
.<span class="ident">field</span>(<span class="string">"DoubleFpConfig"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">DoubleFpConfig</span>))
.<span class="ident">field</span>(<span class="string">"HalfFpConfig"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">HalfFpConfig</span>))
.<span class="ident">field</span>(<span class="string">"PreferredVectorWidthHalf"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">PreferredVectorWidthHalf</span>))
.<span class="ident">field</span>(<span class="string">"HostUnifiedMemory"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">HostUnifiedMemory</span>))
.<span class="ident">field</span>(<span class="string">"NativeVectorWidthChar"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">NativeVectorWidthChar</span>))
.<span class="ident">field</span>(<span class="string">"NativeVectorWidthShort"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">NativeVectorWidthShort</span>))
.<span class="ident">field</span>(<span class="string">"NativeVectorWidthInt"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">NativeVectorWidthInt</span>))
.<span class="ident">field</span>(<span class="string">"NativeVectorWidthLong"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">NativeVectorWidthLong</span>))
.<span class="ident">field</span>(<span class="string">"NativeVectorWidthFloat"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">NativeVectorWidthFloat</span>))
.<span class="ident">field</span>(<span class="string">"NativeVectorWidthDouble"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">NativeVectorWidthDouble</span>))
.<span class="ident">field</span>(<span class="string">"NativeVectorWidthHalf"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">NativeVectorWidthHalf</span>))
.<span class="ident">field</span>(<span class="string">"OpenclCVersion"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">OpenclCVersion</span>))
.<span class="ident">field</span>(<span class="string">"LinkerAvailable"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">LinkerAvailable</span>))
.<span class="ident">field</span>(<span class="string">"BuiltInKernels"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">BuiltInKernels</span>))
.<span class="ident">field</span>(<span class="string">"ImageMaxBufferSize"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">ImageMaxBufferSize</span>))
.<span class="ident">field</span>(<span class="string">"ImageMaxArraySize"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">ImageMaxArraySize</span>))
.<span class="ident">field</span>(<span class="string">"ParentDevice"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">ParentDevice</span>))
.<span class="ident">field</span>(<span class="string">"PartitionMaxSubDevices"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">PartitionMaxSubDevices</span>))
.<span class="ident">field</span>(<span class="string">"PartitionProperties"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">PartitionProperties</span>))
.<span class="ident">field</span>(<span class="string">"PartitionAffinityDomain"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">PartitionAffinityDomain</span>))
.<span class="ident">field</span>(<span class="string">"PartitionType"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">PartitionType</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">DeviceInfo</span>::<span class="ident">ReferenceCount</span>))
.<span class="ident">field</span>(<span class="string">"PreferredInteropUserSync"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">PreferredInteropUserSync</span>))
.<span class="ident">field</span>(<span class="string">"PrintfBufferSize"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">PrintfBufferSize</span>))
.<span class="ident">field</span>(<span class="string">"ImagePitchAlignment"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">ImagePitchAlignment</span>))
.<span class="ident">field</span>(<span class="string">"ImageBaseAddressAlignment"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">DeviceInfo</span>::<span class="ident">ImageBaseAddressAlignment</span>))
.<span class="ident">finish</span>()
}
}
<span class="kw">unsafe</span> <span class="kw">impl</span> <span class="ident">ClDeviceIdPtr</span> <span class="kw">for</span> <span class="ident">Device</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">cl_device_id</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">as_raw</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">ClDeviceIdPtr</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Device</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">cl_device_id</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">as_raw</span>()
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">DeviceIdCore</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Device</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">core</span>: <span class="ident">DeviceIdCore</span>) <span class="op">-></span> <span class="ident">Device</span> {
<span class="ident">Device</span>(<span class="ident">core</span>)
}
}
<span class="comment">// impl Into<String> for Device {</span>
<span class="comment">// fn into(self) -> String {</span>
<span class="comment">// format!("{}", self)</span>
<span class="comment">// }</span>
<span class="comment">// }</span>
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span> <span class="kw">for</span> <span class="ident">String</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">d</span>: <span class="ident">Device</span>) <span class="op">-></span> <span class="ident">String</span> {
<span class="macro">format</span><span class="macro">!</span>(<span class="string">"{}"</span>, <span class="ident">d</span>)
}
}
<span class="comment">// impl Into<DeviceIdCore> for Device {</span>
<span class="comment">// fn into(self) -> DeviceIdCore {</span>
<span class="comment">// self.0</span>
<span class="comment">// }</span>
<span class="comment">// }</span>
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span> <span class="kw">for</span> <span class="ident">DeviceIdCore</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">d</span>: <span class="ident">Device</span>) <span class="op">-></span> <span class="ident">DeviceIdCore</span> {
<span class="ident">d</span>.<span class="number">0</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">Device</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">Device</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Device</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">Device</span> {
<span class="self">self</span>
}
}
<span class="kw">impl</span> <span class="ident">Deref</span> <span class="kw">for</span> <span class="ident">Device</span> {
<span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">DeviceIdCore</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">DeviceIdCore</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>
}
}
<span class="kw">impl</span> <span class="ident">DerefMut</span> <span class="kw">for</span> <span class="ident">Device</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">DeviceIdCore</span> {
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="number">0</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>