<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="Source to the Rust file `/Users/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/ocl-0.18.0/src/standard/program.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>program.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../../dark.css">
<link rel="stylesheet" type="text/css" href="../../../main.css" id="themeStyle">
<script src="../../../storage.js"></script>
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<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>
</pre><pre class="rust ">
<span class="doccomment">//! An `OpenCL` program.</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">ffi</span>::<span class="ident">CString</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Read</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>::<span class="ident">File</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">path</span>::<span class="ident">PathBuf</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">collections</span>::<span class="ident">HashSet</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">convert</span>::<span class="ident">Into</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">Program</span> <span class="kw">as</span> <span class="ident">ProgramCore</span>, <span class="ident">Context</span> <span class="kw">as</span> <span class="ident">ContextCore</span>,
<span class="ident">ProgramInfo</span>, <span class="ident">ProgramInfoResult</span>, <span class="ident">ProgramBuildInfo</span>, <span class="ident">ProgramBuildInfoResult</span>};
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"opencl_version_2_1"</span>)]</span>
<span class="kw">use</span> <span class="ident">core</span>::<span class="ident">ClVersions</span>;
<span class="kw">use</span> <span class="ident">error</span>::{<span class="prelude-ty">Result</span> <span class="kw">as</span> <span class="ident">OclResult</span>, <span class="ident">Error</span> <span class="kw">as</span> <span class="ident">OclError</span>};
<span class="kw">use</span> <span class="ident">standard</span>::{<span class="ident">Context</span>, <span class="ident">Device</span>, <span class="ident">DeviceSpecifier</span>};
<span class="doccomment">/// A program from which kernels can be created from.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// To use with multiple devices, create manually with `::from_parts()`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Destruction</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Handled automatically. Feel free to store, clone, and share among threads</span>
<span class="doccomment">/// as you please.</span>
<span class="doccomment">///</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">Program</span>(<span class="ident">ProgramCore</span>);
<span class="kw">impl</span> <span class="ident">Program</span> {
<span class="doccomment">/// Returns a new `ProgramBuilder`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">builder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span>() <span class="op">-></span> <span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="ident">ProgramBuilder</span>::<span class="ident">new</span>()
}
<span class="doccomment">/// Returns a new program built from pre-created build components and device</span>
<span class="doccomment">/// list.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Prefer `::builder` to create a new `Program`.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_source</span>(<span class="ident">context</span>: <span class="kw-2">&</span><span class="ident">ContextCore</span>, <span class="ident">src_strings</span>: <span class="kw-2">&</span>[<span class="ident">CString</span>],
<span class="ident">devices</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">Device</span>]<span class="op">></span>, <span class="ident">cmplr_opts</span>: <span class="kw-2">&</span><span class="ident">CString</span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Program</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">program</span> <span class="op">=</span> <span class="ident">core</span>::<span class="ident">create_program_with_source</span>(<span class="ident">context</span>, <span class="ident">src_strings</span>)<span class="question-mark">?</span>;
<span class="ident">core</span>::<span class="ident">build_program</span>(<span class="kw-2">&</span><span class="ident">program</span>, <span class="ident">devices</span>, <span class="ident">cmplr_opts</span>, <span class="prelude-val">None</span>, <span class="prelude-val">None</span>)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="ident">Program</span>(<span class="ident">program</span>))
}
<span class="doccomment">/// Returns a new program built from pre-created build components and device</span>
<span class="doccomment">/// list.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Prefer `::builder` to create a new `Program`.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_binary</span>(<span class="ident">context</span>: <span class="kw-2">&</span><span class="ident">ContextCore</span>, <span class="ident">devices</span>: <span class="kw-2">&</span>[<span class="ident">Device</span>],
<span class="ident">binaries</span>: <span class="kw-2">&</span>[<span class="kw-2">&</span>[<span class="ident">u8</span>]], <span class="ident">cmplr_opts</span>: <span class="kw-2">&</span><span class="ident">CString</span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Program</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">program</span> <span class="op">=</span> <span class="ident">core</span>::<span class="ident">create_program_with_binary</span>(<span class="ident">context</span>, <span class="ident">devices</span>, <span class="ident">binaries</span>)<span class="question-mark">?</span>;
<span class="ident">core</span>::<span class="ident">build_program</span>(<span class="kw-2">&</span><span class="ident">program</span>, <span class="prelude-val">Some</span>(<span class="ident">devices</span>), <span class="ident">cmplr_opts</span>, <span class="prelude-val">None</span>, <span class="prelude-val">None</span>)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="ident">Program</span>(<span class="ident">program</span>))
}
<span class="doccomment">/// Returns a new program built from pre-created build components and device</span>
<span class="doccomment">/// list for programs with intermediate language byte source.</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"opencl_version_2_1"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_il</span>(<span class="ident">il</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="ident">devices</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">Device</span>]<span class="op">></span>, <span class="ident">cmplr_opts</span>: <span class="kw-2">&</span><span class="ident">CString</span>,
<span class="ident">context</span>: <span class="kw-2">&</span><span class="ident">ContextCore</span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Program</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">device_versions</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">device_versions</span>()<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">program</span> <span class="op">=</span> <span class="ident">core</span>::<span class="ident">create_program_with_il</span>(<span class="ident">context</span>, <span class="ident">il</span>, <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="ident">device_versions</span>))<span class="question-mark">?</span>;
<span class="ident">core</span>::<span class="ident">build_program</span>(<span class="kw-2">&</span><span class="ident">program</span>, <span class="ident">devices</span>, <span class="ident">cmplr_opts</span>, <span class="prelude-val">None</span>, <span class="prelude-val">None</span>)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="ident">Program</span>(<span class="ident">program</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">ProgramCore</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>
}
<span class="doccomment">/// Returns info about this program.</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">ProgramInfo</span>) <span class="op">-></span> <span class="ident">OclCoreResult</span><span class="op"><</span><span class="ident">ProgramInfoResult</span><span class="op">></span> {
<span class="ident">core</span>::<span class="ident">get_program_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 info about this program's build.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * TODO: Check that device is valid.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build_info</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">device</span>: <span class="ident">Device</span>, <span class="ident">info_kind</span>: <span class="ident">ProgramBuildInfo</span>)
<span class="op">-></span> <span class="ident">OclCoreResult</span><span class="op"><</span><span class="ident">ProgramBuildInfoResult</span><span class="op">></span> {
<span class="ident">core</span>::<span class="ident">get_program_build_info</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>, <span class="kw-2">&</span><span class="ident">device</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">"Program"</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">ProgramInfo</span>::<span class="ident">ReferenceCount</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">ProgramInfo</span>::<span class="ident">Context</span>))
.<span class="ident">field</span>(<span class="string">"NumDevices"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">ProgramInfo</span>::<span class="ident">NumDevices</span>))
.<span class="ident">field</span>(<span class="string">"Devices"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">ProgramInfo</span>::<span class="ident">Devices</span>))
.<span class="ident">field</span>(<span class="string">"Source"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">ProgramInfo</span>::<span class="ident">Source</span>))
.<span class="ident">field</span>(<span class="string">"BinarySizes"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">ProgramInfo</span>::<span class="ident">BinarySizes</span>))
.<span class="ident">field</span>(<span class="string">"Binaries"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">ProgramInfo</span>::<span class="ident">Binaries</span>))
.<span class="ident">field</span>(<span class="string">"NumKernels"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">ProgramInfo</span>::<span class="ident">NumKernels</span>))
.<span class="ident">field</span>(<span class="string">"KernelNames"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">ProgramInfo</span>::<span class="ident">KernelNames</span>))
.<span class="ident">finish</span>()
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">ProgramCore</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Program</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">core</span>: <span class="ident">ProgramCore</span>) <span class="op">-></span> <span class="ident">Program</span> {
<span class="ident">Program</span>(<span class="ident">core</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">Program</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">Deref</span> <span class="kw">for</span> <span class="ident">Program</span> {
<span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">ProgramCore</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">ProgramCore</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">Program</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">ProgramCore</span> {
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="number">0</span>
}
}
<span class="doccomment">/// A build option used by ProgramBuilder.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Strings intended for use either by the compiler as a command line switch</span>
<span class="doccomment">/// or for inclusion in the final build source code.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// A few of the often used variants have constructors for convenience.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * [FIXME] TODO: Explain how each variant is used.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * [FIXME] TODO: Examples.</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">enum</span> <span class="ident">BuildOpt</span> {
<span class="ident">CmplrDefine</span> { <span class="ident">ident</span>: <span class="ident">String</span>, <span class="ident">val</span>: <span class="ident">String</span> },
<span class="ident">CmplrInclDir</span> { <span class="ident">path</span>: <span class="ident">String</span> },
<span class="ident">CmplrOther</span>(<span class="ident">String</span>),
<span class="ident">IncludeDefine</span> { <span class="ident">ident</span>: <span class="ident">String</span>, <span class="ident">val</span>: <span class="ident">String</span> },
<span class="ident">IncludeRaw</span>(<span class="ident">String</span>),
<span class="ident">IncludeRawEof</span>(<span class="ident">String</span>),
}
<span class="kw">impl</span> <span class="ident">BuildOpt</span> {
<span class="doccomment">/// Returns a `BuildOpt::CmplrDefine`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">cmplr_def</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">>></span>(<span class="ident">ident</span>: <span class="ident">S</span>, <span class="ident">val</span>: <span class="ident">i32</span>) <span class="op">-></span> <span class="ident">BuildOpt</span> {
<span class="ident">BuildOpt</span>::<span class="ident">CmplrDefine</span> {
<span class="ident">ident</span>: <span class="ident">ident</span>.<span class="ident">into</span>(),
<span class="ident">val</span>: <span class="ident">val</span>.<span class="ident">to_string</span>(),
}
}
<span class="doccomment">/// Returns a `BuildOpt::IncludeDefine`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">include_def</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">>></span>(<span class="ident">ident</span>: <span class="ident">S</span>, <span class="ident">val</span>: <span class="ident">String</span>) <span class="op">-></span> <span class="ident">BuildOpt</span> {
<span class="ident">BuildOpt</span>::<span class="ident">IncludeDefine</span> {
<span class="ident">ident</span>: <span class="ident">ident</span>.<span class="ident">into</span>(),
<span class="ident">val</span>: <span class="ident">val</span>,
}
}
}
<span class="doccomment">/// Options for program creation.</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">dead_code</span>)]</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">enum</span> <span class="ident">CreateWith</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="prelude-val">None</span>,
<span class="ident">Source</span>(<span class="ident">Vec</span><span class="op"><</span><span class="ident">PathBuf</span><span class="op">></span>),
<span class="ident">Binaries</span>(<span class="kw-2">&</span><span class="lifetime">'b</span>[<span class="kw-2">&</span><span class="lifetime">'b</span> [<span class="ident">u8</span>]]),
<span class="ident">Il</span>(<span class="kw-2">&</span><span class="lifetime">'b</span> [<span class="ident">u8</span>]),
}
<span class="doccomment">/// A builder for `Program`.</span>
<span class="doccomment">///</span>
<span class="comment">// * [SOMEDAY TODO]: Keep track of line number range for each string and print</span>
<span class="comment">// out during build failure.</span>
<span class="comment">//</span>
<span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">"builders do nothing unless '::build' is called"</span>]</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">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="ident">options</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">BuildOpt</span><span class="op">></span>,
<span class="ident">with</span>: <span class="ident">CreateWith</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span>,
<span class="ident">device_spec</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">DeviceSpecifier</span><span class="op">></span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> <span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="doccomment">/// Returns a new, empty, build configuration object.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-></span> <span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="ident">ProgramBuilder</span> {
<span class="ident">options</span>: <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="number">64</span>),
<span class="ident">with</span>: <span class="ident">CreateWith</span>::<span class="prelude-val">None</span>,
<span class="ident">device_spec</span>: <span class="prelude-val">None</span>,
}
}
<span class="doccomment">/// Adds a build option containing a compiler command line definition.</span>
<span class="doccomment">/// Formatted as `-D {name}={val}`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// `...cmplr_def("MAX_ITERS", 500)...`</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">cmplr_def</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">>></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">name</span>: <span class="ident">S</span>, <span class="ident">val</span>: <span class="ident">i32</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">options</span>.<span class="ident">push</span>(<span class="ident">BuildOpt</span>::<span class="ident">cmplr_def</span>(<span class="ident">name</span>, <span class="ident">val</span>));
<span class="self">self</span>
}
<span class="doccomment">/// Adds a build option containing a raw compiler command line parameter.</span>
<span class="doccomment">/// Formatted as `{}` (exact text).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// `...cmplr_opt("-g")...`</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">cmplr_opt</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">>></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">co</span>: <span class="ident">S</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">options</span>.<span class="ident">push</span>(<span class="ident">BuildOpt</span>::<span class="ident">CmplrOther</span>(<span class="ident">co</span>.<span class="ident">into</span>()));
<span class="self">self</span>
}
<span class="doccomment">/// Pushes pre-created build option to the list of options.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If either `::il` or `::binaries` are used and raw source is added, it</span>
<span class="doccomment">/// will be ignored.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">bo</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">bo</span>: <span class="ident">BuildOpt</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">options</span>.<span class="ident">push</span>(<span class="ident">bo</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Adds the contents of a file to the program.</span>
<span class="comment">//</span>
<span class="comment">// TODO: Deprecate</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">src_file</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">P</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">PathBuf</span><span class="op">>></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">file_path</span>: <span class="ident">P</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">source_file</span>(<span class="ident">file_path</span>)
}
<span class="doccomment">/// Opens a file and adds its contents to the program source.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">source_file</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">P</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">PathBuf</span><span class="op">>></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">file_path</span>: <span class="ident">P</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">file_path</span> <span class="op">=</span> <span class="ident">file_path</span>.<span class="ident">into</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">file_path</span>.<span class="ident">is_file</span>(), <span class="string">"ProgramBuilder::src_file(): Source file error: \
'{}' does not exist."</span>, <span class="ident">file_path</span>.<span class="ident">display</span>());
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">with</span> {
<span class="ident">CreateWith</span>::<span class="prelude-val">None</span> <span class="op">=></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">paths</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="number">8</span>);
<span class="ident">paths</span>.<span class="ident">push</span>(<span class="ident">file_path</span>);
<span class="self">self</span>.<span class="ident">with</span> <span class="op">=</span> <span class="ident">CreateWith</span>::<span class="ident">Source</span>(<span class="ident">paths</span>);
}
<span class="ident">CreateWith</span>::<span class="ident">Source</span>(<span class="kw-2">ref</span> <span class="kw-2">mut</span> <span class="ident">paths</span>) <span class="op">=></span> <span class="ident">paths</span>.<span class="ident">push</span>(<span class="ident">file_path</span>),
_ <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Source may not be used with binaries or il."</span>),
}
<span class="self">self</span>
}
<span class="doccomment">/// Adds raw text to the program source.</span>
<span class="comment">//</span>
<span class="comment">// TODO: Deprecate</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">src</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">>></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">src</span>: <span class="ident">S</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">source</span>(<span class="ident">src</span>)
}
<span class="doccomment">/// Adds raw text to the program source.</span>
<span class="comment">//</span>
<span class="comment">// [TODO]: Possibly accept Into<CString></span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">source</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">>></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">src</span>: <span class="ident">S</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">with</span> {
<span class="ident">CreateWith</span>::<span class="prelude-val">None</span> <span class="op">=></span> {
<span class="self">self</span>.<span class="ident">with</span> <span class="op">=</span> <span class="ident">CreateWith</span>::<span class="ident">Source</span>(<span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="number">8</span>));
<span class="self">self</span>.<span class="ident">options</span>.<span class="ident">push</span>(<span class="ident">BuildOpt</span>::<span class="ident">IncludeRawEof</span>(<span class="ident">src</span>.<span class="ident">into</span>()));
}
<span class="ident">CreateWith</span>::<span class="ident">Source</span>(_) <span class="op">=></span> {
<span class="self">self</span>.<span class="ident">options</span>.<span class="ident">push</span>(<span class="ident">BuildOpt</span>::<span class="ident">IncludeRawEof</span>(<span class="ident">src</span>.<span class="ident">into</span>()));
}
_ <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Source may not be used with binaries or il."</span>),
}
<span class="self">self</span>
}
<span class="doccomment">/// Adds a binary to be loaded.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// There must be one binary for each device listed in `::devices`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">binaries</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">bins</span>: <span class="kw-2">&</span><span class="lifetime">'b</span>[<span class="kw-2">&</span><span class="lifetime">'b</span> [<span class="ident">u8</span>]]) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">with</span> {
<span class="ident">CreateWith</span>::<span class="prelude-val">None</span> <span class="op">=></span> <span class="self">self</span>.<span class="ident">with</span> <span class="op">=</span> <span class="ident">CreateWith</span>::<span class="ident">Binaries</span>(<span class="ident">bins</span>),
<span class="ident">CreateWith</span>::<span class="ident">Binaries</span>(_) <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Binaries have already been specified."</span>),
_ <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Binaries may not be used with source or il."</span>),
}
<span class="self">self</span>
}
<span class="doccomment">/// Adds</span>
<span class="doccomment">/// Adds SPIR-V or an implementation-defined intermediate language to this program.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Any source files or source text added to this build will cause an</span>
<span class="doccomment">/// error upon building.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Use the `include_bytes!` macro to include source code from a file statically.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * TODO: Future addition: Allow IL to be loaded directly from a file</span>
<span class="doccomment">/// in the same way that text source is.</span>
<span class="doccomment">///</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"opencl_version_2_1"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">il</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">il</span>: <span class="kw-2">&</span><span class="lifetime">'b</span> [<span class="ident">u8</span>]) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">with</span> {
<span class="ident">CreateWith</span>::<span class="prelude-val">None</span> <span class="op">=></span> <span class="self">self</span>.<span class="ident">with</span> <span class="op">=</span> <span class="ident">CreateWith</span>::<span class="ident">Il</span>(<span class="ident">il</span>),
<span class="ident">CreateWith</span>::<span class="ident">Il</span>(_) <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Il has already been specified."</span>),
_ <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Il may not be used with source or binaries."</span>),
}
<span class="self">self</span>
}
<span class="doccomment">/// Specifies a list of devices to build this program on. The devices must</span>
<span class="doccomment">/// be associated with the context passed to `::build` later on.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Devices may be specified in any number of ways including simply</span>
<span class="doccomment">/// passing a device or slice of devices. See the [`impl</span>
<span class="doccomment">/// From`][device_specifier_from] section of</span>
<span class="doccomment">/// [`DeviceSpecifier`][device_specifier] for more information.</span>
<span class="doccomment">///</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Devices must not have already been specified.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [device_specifier_from]: enum.DeviceSpecifier.html#method.from</span>
<span class="doccomment">/// [device_specifier]: enum.DeviceSpecifier.html</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">devices</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">D</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">DeviceSpecifier</span><span class="op">>></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">device_spec</span>: <span class="ident">D</span>)
<span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="macro">assert</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">device_spec</span>.<span class="ident">is_none</span>(), <span class="string">"ocl::ProgramBuilder::devices(): Devices already specified"</span>);
<span class="self">self</span>.<span class="ident">device_spec</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">device_spec</span>.<span class="ident">into</span>());
<span class="self">self</span>
}
<span class="doccomment">/// Returns the devices specified to be associated the program.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_device_spec</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">DeviceSpecifier</span><span class="op">></span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">device_spec</span>
}
<span class="doccomment">/// Returns a concatenated string of command line options to be passed to</span>
<span class="doccomment">/// the compiler when building this program.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_compiler_options</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">CString</span><span class="op">></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">opts</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="number">64</span>);
<span class="kw">for</span> <span class="ident">option</span> <span class="kw">in</span> <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">options</span> {
<span class="kw">match</span> <span class="kw-2">*</span><span class="ident">option</span> {
<span class="ident">BuildOpt</span>::<span class="ident">CmplrDefine</span> { <span class="kw-2">ref</span> <span class="ident">ident</span>, <span class="kw-2">ref</span> <span class="ident">val</span> } <span class="op">=></span> {
<span class="ident">opts</span>.<span class="ident">push</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"-D {}={}"</span>, <span class="ident">ident</span>, <span class="ident">val</span>))
},
<span class="ident">BuildOpt</span>::<span class="ident">CmplrInclDir</span> { <span class="kw-2">ref</span> <span class="ident">path</span> } <span class="op">=></span> {
<span class="ident">opts</span>.<span class="ident">push</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"-I {}"</span>, <span class="ident">path</span>))
},
<span class="ident">BuildOpt</span>::<span class="ident">CmplrOther</span>(<span class="kw-2">ref</span> <span class="ident">s</span>) <span class="op">=></span> {
<span class="ident">opts</span>.<span class="ident">push</span>(<span class="ident">s</span>.<span class="ident">clone</span>())
},
_ <span class="op">=></span> (),
}
}
<span class="ident">CString</span>::<span class="ident">new</span>(<span class="ident">opts</span>.<span class="ident">join</span>(<span class="string">" "</span>).<span class="ident">into_bytes</span>()).<span class="ident">map_err</span>(<span class="ident">OclError</span>::<span class="ident">from</span>)
}
<span class="doccomment">/// Parses `self.options` for options intended for inclusion at the beginning of</span>
<span class="doccomment">/// the final program source and returns them as a list of strings.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Generally used for #define directives, constants, etc. Normally called from</span>
<span class="doccomment">/// `::get_src_strings()`.</span>
<span class="kw">fn</span> <span class="ident">get_includes</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">Vec</span><span class="op"><</span><span class="ident">CString</span><span class="op">>></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">strings</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="number">64</span>);
<span class="ident">strings</span>.<span class="ident">push</span>(<span class="ident">CString</span>::<span class="ident">new</span>(<span class="string">"\n"</span>.<span class="ident">as_bytes</span>())<span class="question-mark">?</span>);
<span class="kw">for</span> <span class="ident">option</span> <span class="kw">in</span> <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">options</span> {
<span class="kw">match</span> <span class="kw-2">*</span><span class="ident">option</span> {
<span class="ident">BuildOpt</span>::<span class="ident">IncludeDefine</span> { <span class="kw-2">ref</span> <span class="ident">ident</span>, <span class="kw-2">ref</span> <span class="ident">val</span> } <span class="op">=></span> {
<span class="ident">strings</span>.<span class="ident">push</span>(<span class="ident">CString</span>::<span class="ident">new</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"#define {} {}\n"</span>, <span class="ident">ident</span>, <span class="ident">val</span>)
.<span class="ident">into_bytes</span>())<span class="question-mark">?</span>);
},
<span class="ident">BuildOpt</span>::<span class="ident">IncludeRaw</span>(<span class="kw-2">ref</span> <span class="ident">text</span>) <span class="op">=></span> {
<span class="ident">strings</span>.<span class="ident">push</span>(<span class="ident">CString</span>::<span class="ident">new</span>(<span class="ident">text</span>.<span class="ident">clone</span>().<span class="ident">into_bytes</span>())<span class="question-mark">?</span>);
},
_ <span class="op">=></span> (),
};
}
<span class="ident">strings</span>.<span class="ident">shrink_to_fit</span>();
<span class="prelude-val">Ok</span>(<span class="ident">strings</span>)
}
<span class="doccomment">/// Parses `self.options` for options intended for inclusion at the end of</span>
<span class="doccomment">/// the final program source and returns them as a list of strings.</span>
<span class="kw">fn</span> <span class="ident">get_includes_eof</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">Vec</span><span class="op"><</span><span class="ident">CString</span><span class="op">>></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">strings</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="number">64</span>);
<span class="ident">strings</span>.<span class="ident">push</span>(<span class="ident">CString</span>::<span class="ident">new</span>(<span class="string">"\n"</span>.<span class="ident">as_bytes</span>())<span class="question-mark">?</span>);
<span class="kw">for</span> <span class="ident">option</span> <span class="kw">in</span> <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">options</span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="ident">BuildOpt</span>::<span class="ident">IncludeRawEof</span>(<span class="kw-2">ref</span> <span class="ident">text</span>) <span class="op">=</span> <span class="kw-2">*</span><span class="ident">option</span> {
<span class="ident">strings</span>.<span class="ident">push</span>(<span class="ident">CString</span>::<span class="ident">new</span>(<span class="ident">text</span>.<span class="ident">clone</span>().<span class="ident">into_bytes</span>())<span class="question-mark">?</span>);
}
}
<span class="ident">strings</span>.<span class="ident">shrink_to_fit</span>();
<span class="prelude-val">Ok</span>(<span class="ident">strings</span>)
}
<span class="doccomment">/// Returns the final program source code as a list of strings.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ### Order of Inclusion</span>
<span class="doccomment">///</span>
<span class="doccomment">/// 1. Macro definitions and code strings specified by a</span>
<span class="doccomment">/// `BuildOpt::IncludeDefine` or `BuildOpt::IncludeRaw` via `::bo`</span>
<span class="doccomment">/// 2. Contents of files specified via `::src_file`</span>
<span class="doccomment">/// 3. Contents of strings specified via `::src` or a</span>
<span class="doccomment">/// `BuildOpt::IncludeRawEof` via `::bo`</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_src_strings</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">Vec</span><span class="op"><</span><span class="ident">CString</span><span class="op">>></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">src_strings</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">CString</span><span class="op">></span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="number">64</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">src_file_history</span>: <span class="ident">HashSet</span><span class="op"><</span><span class="ident">PathBuf</span><span class="op">></span> <span class="op">=</span> <span class="ident">HashSet</span>::<span class="ident">with_capacity</span>(<span class="number">64</span>);
<span class="ident">src_strings</span>.<span class="ident">extend_from_slice</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">get_includes</span>()<span class="question-mark">?</span>);
<span class="kw">let</span> <span class="ident">src_paths</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">with</span> {
<span class="ident">CreateWith</span>::<span class="ident">Source</span>(<span class="kw-2">ref</span> <span class="ident">paths</span>) <span class="op">=></span> <span class="ident">paths</span>,
_ <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Cannot build program. No source specified."</span>),
};
<span class="kw">for</span> <span class="ident">src_path</span> <span class="kw">in</span> <span class="ident">src_paths</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">src_bytes</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="number">100000</span>);
<span class="kw">if</span> <span class="ident">src_file_history</span>.<span class="ident">contains</span>(<span class="ident">src_path</span>) { <span class="kw">continue</span>; }
<span class="ident">src_file_history</span>.<span class="ident">insert</span>(<span class="ident">src_path</span>.<span class="ident">clone</span>());
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">src_file_handle</span> <span class="op">=</span> <span class="ident">File</span>::<span class="ident">open</span>(<span class="ident">src_path</span>)<span class="question-mark">?</span>;
<span class="ident">src_file_handle</span>.<span class="ident">read_to_end</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">src_bytes</span>)<span class="question-mark">?</span>;
<span class="ident">src_bytes</span>.<span class="ident">shrink_to_fit</span>();
<span class="ident">src_strings</span>.<span class="ident">push</span>(<span class="ident">CString</span>::<span class="ident">new</span>(<span class="ident">src_bytes</span>)<span class="question-mark">?</span>);
}
<span class="ident">src_strings</span>.<span class="ident">extend_from_slice</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">get_includes_eof</span>()<span class="question-mark">?</span>);
<span class="ident">src_strings</span>.<span class="ident">shrink_to_fit</span>();
<span class="prelude-val">Ok</span>(<span class="ident">src_strings</span>)
}
<span class="doccomment">/// Returns a newly built Program.</span>
<span class="comment">//</span>
<span class="comment">// * TODO: If the context is associated with more than one device,</span>
<span class="comment">// check that at least one of those devices has been specified. An empty</span>
<span class="comment">// device list will cause an `OpenCL` error in that case.</span>
<span class="comment">// * TODO: Check for duplicate devices in the final device list.</span>
<span class="comment">// * TODO: Consider moving context to its own method.</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"opencl_version_2_1"</span>))]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">context</span>: <span class="kw-2">&</span><span class="ident">Context</span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Program</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">device_list</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">device_spec</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">ds</span>) <span class="op">=></span> <span class="ident">ds</span>.<span class="ident">to_device_list</span>(<span class="ident">context</span>.<span class="ident">platform</span>()<span class="question-mark">?</span>)<span class="question-mark">?</span>,
<span class="prelude-val">None</span> <span class="op">=></span> <span class="ident">context</span>.<span class="ident">devices</span>(),
};
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">with</span> {
<span class="ident">CreateWith</span>::<span class="ident">Il</span>(_) <span class="op">=></span> {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="string">"ocl::ProgramBuilder::build: Unreachable section (IL)."</span>.<span class="ident">into</span>());
},
<span class="ident">CreateWith</span>::<span class="ident">Source</span>(_) <span class="op">=></span> {
<span class="ident">Program</span>::<span class="ident">with_source</span>(
<span class="ident">context</span>,
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">get_src_strings</span>()<span class="question-mark">?</span>,
<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="ident">device_list</span>[..]),
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">get_compiler_options</span>()<span class="question-mark">?</span>,
).<span class="ident">map_err</span>(<span class="ident">OclError</span>::<span class="ident">from</span>)
},
<span class="ident">CreateWith</span>::<span class="ident">Binaries</span>(<span class="ident">bins</span>) <span class="op">=></span> {
<span class="ident">Program</span>::<span class="ident">with_binary</span>(
<span class="ident">context</span>,
<span class="kw-2">&</span><span class="ident">device_list</span>[..],
<span class="ident">bins</span>,
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">get_compiler_options</span>()<span class="question-mark">?</span>,
)
},
<span class="ident">CreateWith</span>::<span class="prelude-val">None</span> <span class="op">=></span> <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="string">"Unable to build program: no source, binary, \
or IL has been specified"</span>.<span class="ident">into</span>()),
}
}
<span class="doccomment">/// Returns a newly built Program.</span>
<span class="comment">//</span>
<span class="comment">// * TODO: If the context is associated with more than one device,</span>
<span class="comment">// check that at least one of those devices has been specified. An empty</span>
<span class="comment">// device list will cause an `OpenCL` error in that case.</span>
<span class="comment">//</span>
<span class="comment">// * TODO: Check for duplicate devices in the final device list.</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"opencl_version_2_1"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">context</span>: <span class="kw-2">&</span><span class="ident">Context</span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Program</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">device_list</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">device_spec</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">ds</span>) <span class="op">=></span> <span class="ident">ds</span>.<span class="ident">to_device_list</span>(<span class="ident">context</span>.<span class="ident">platform</span>()<span class="question-mark">?</span>)<span class="question-mark">?</span>,
<span class="prelude-val">None</span> <span class="op">=></span> <span class="ident">context</span>.<span class="ident">devices</span>().<span class="ident">to_owned</span>(),
};
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">with</span> {
<span class="ident">CreateWith</span>::<span class="ident">Il</span>(<span class="ident">il</span>) <span class="op">=></span> {
<span class="ident">Program</span>::<span class="ident">with_il</span>(
<span class="ident">il</span>,
<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="ident">device_list</span>[..]),
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">get_compiler_options</span>()<span class="question-mark">?</span>,
<span class="ident">context</span>
)
},
<span class="ident">CreateWith</span>::<span class="ident">Source</span>(_) <span class="op">=></span> {
<span class="ident">Program</span>::<span class="ident">with_source</span>(
<span class="ident">context</span>,
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">get_src_strings</span>()<span class="question-mark">?</span>,
<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="ident">device_list</span>[..]),
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">get_compiler_options</span>()<span class="question-mark">?</span>,
)
},
<span class="ident">CreateWith</span>::<span class="ident">Binaries</span>(<span class="ident">bins</span>) <span class="op">=></span> {
<span class="ident">Program</span>::<span class="ident">with_binary</span>(
<span class="ident">context</span>,
<span class="kw-2">&</span><span class="ident">device_list</span>[..],
<span class="ident">bins</span>,
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">get_compiler_options</span>()<span class="question-mark">?</span>,
)
},
<span class="ident">CreateWith</span>::<span class="prelude-val">None</span> <span class="op">=></span> <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="string">"Unable to build program: no source, binary, \
or IL has been specified"</span>.<span class="ident">into</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>