<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="generator" content="rustdoc">
    <meta name="description" content="Source to the Rust file `/Users/travis/.cargo/git/checkouts/ocl-21810c0a37a638dd/c345b5b/ocl/src/standard/platform.rs`.">
    <meta name="keywords" content="rust, rustlang, rust-lang">

    <title>platform.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">&#9776;</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>
</pre><pre class="rust ">
<span class="doccomment">//! An `OpenCL` platform identifier.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Documentation copied from [https://www.khronos.org/registry/cl/sdk/1.2/doc</span>
<span class="doccomment">//! s/man/xhtml/clGetPlatformInfo.html](https://www.khronos.org/registry/cl/sd</span>
<span class="doccomment">//! k/1.2/docs/man/xhtml/clGetPlatformInfo.html)</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">str</span>::<span class="ident">SplitWhitespace</span>;
<span class="kw">use</span> <span class="ident">ffi</span>::<span class="ident">cl_platform_id</span>;
<span class="kw">use</span> <span class="ident">core</span>::{<span class="self">self</span>, <span class="ident">PlatformId</span> <span class="kw">as</span> <span class="ident">PlatformIdCore</span>, <span class="ident">PlatformInfo</span>, <span class="ident">PlatformInfoResult</span>, <span class="ident">ClPlatformIdPtr</span>};
<span class="kw">use</span> <span class="ident">core</span>::<span class="ident">error</span>::{<span class="prelude-ty">Result</span> <span class="kw">as</span> <span class="ident">OclCoreResult</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="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Fail</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">PlatformError</span> {
    <span class="attribute">#[<span class="ident">fail</span>(<span class="ident">display</span> <span class="op">=</span> <span class="string">&quot;No platforms found.&quot;</span>)]</span>
    <span class="ident">NoPlatforms</span>,
}


<span class="doccomment">/// Extensions of a platform.</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">struct</span> <span class="ident">Extensions</span> {
    <span class="ident">inner</span>: <span class="ident">String</span>,
}

<span class="kw">impl</span> <span class="ident">Extensions</span> {
    <span class="doccomment">/// Iterate over platform extensions, split at whitespace.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">iter</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">SplitWhitespace</span> {
        <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">split_whitespace</span>()
    }

    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_str</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="ident">str</span> {
        <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">inner</span>
    }
}


<span class="doccomment">/// A platform identifier.</span>
<span class="doccomment">///</span>
<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</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>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Platform</span>(<span class="ident">PlatformIdCore</span>);

<span class="kw">impl</span> <span class="ident">Platform</span> {
    <span class="doccomment">/// Returns a list of all platforms avaliable on the host machine.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">list</span>() <span class="op">-&gt;</span> <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">Platform</span><span class="op">&gt;</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_platform_ids</span>()
            .<span class="ident">expect</span>(<span class="string">&quot;Platform::list: Error retrieving platform list&quot;</span>);

        <span class="ident">list_core</span>.<span class="ident">into_iter</span>().<span class="ident">map</span>(<span class="ident">Platform</span>::<span class="ident">new</span>).<span class="ident">collect</span>()
    }

    <span class="doccomment">/// Returns the first available platform.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// This method differs from `Platform::default()` in two ways. First, it</span>
    <span class="doccomment">/// ignores the `OCL_DEFAULT_PLATFORM_IDX` environment variable</span>
    <span class="doccomment">/// (`Platform::default` always respects it). Second, this function will</span>
    <span class="doccomment">/// not panic if no platforms are available but will instead return an</span>
    <span class="doccomment">/// error.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">first</span>() <span class="op">-&gt;</span> <span class="ident">OclResult</span><span class="op">&lt;</span><span class="ident">Platform</span><span class="op">&gt;</span> {
        <span class="ident">core</span>::<span class="ident">get_platform_ids</span>()<span class="question-mark">?</span>
            .<span class="ident">first</span>()
            .<span class="ident">map</span>(<span class="op">|</span><span class="kw-2">&amp;</span><span class="ident">p</span><span class="op">|</span> <span class="ident">Platform</span>::<span class="ident">new</span>(<span class="ident">p</span>))
            .<span class="ident">ok_or</span>(<span class="ident">PlatformError</span>::<span class="ident">NoPlatforms</span>.<span class="ident">into</span>())
    }

    <span class="doccomment">/// Creates a new `Platform` from a `PlatformIdCore`.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ## Safety</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Not meant to be called unless you know what you&#39;re doing.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Use list to get a list of platforms.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">id_core</span>: <span class="ident">PlatformIdCore</span>) <span class="op">-&gt;</span> <span class="ident">Platform</span> {
        <span class="ident">Platform</span>(<span class="ident">id_core</span>)
    }

    <span class="doccomment">/// Returns a list of `Platform`s from a list of `PlatformIdCore`s</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">list_from_core</span>(<span class="ident">platforms</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">PlatformIdCore</span><span class="op">&gt;</span>) <span class="op">-&gt;</span> <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">Platform</span><span class="op">&gt;</span> {
        <span class="ident">platforms</span>.<span class="ident">into_iter</span>().<span class="ident">map</span>(<span class="ident">Platform</span>::<span class="ident">new</span>).<span class="ident">collect</span>()
    }

    <span class="doccomment">/// Returns info about the platform.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">info</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">info_kind</span>: <span class="ident">PlatformInfo</span>) <span class="op">-&gt;</span> <span class="ident">OclCoreResult</span><span class="op">&lt;</span><span class="ident">PlatformInfoResult</span><span class="op">&gt;</span> {
        <span class="ident">core</span>::<span class="ident">get_platform_info</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>, <span class="ident">info_kind</span>)
    }

    <span class="doccomment">/// Returns the platform profile as a string.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Returns the profile name supported by the implementation. The profile</span>
    <span class="doccomment">/// name returned can be one of the following strings:</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// * FULL_PROFILE - if the implementation supports the OpenCL</span>
    <span class="doccomment">///   specification (functionality defined as part of the core</span>
    <span class="doccomment">///   specification and does not require any extensions to be supported).</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// * EMBEDDED_PROFILE - if the implementation supports the OpenCL</span>
    <span class="doccomment">///   embedded profile. The embedded profile is defined to be a subset for</span>
    <span class="doccomment">///   each version of OpenCL.</span>
    <span class="doccomment">///</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">profile</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">OclCoreResult</span><span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span> {
        <span class="ident">core</span>::<span class="ident">get_platform_info</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>, <span class="ident">PlatformInfo</span>::<span class="ident">Profile</span>).<span class="ident">map</span>(<span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">into</span>())
    }

    <span class="doccomment">/// Returns the platform driver version as a string.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Returns the OpenCL version supported by the implementation. This</span>
    <span class="doccomment">/// version string has the following format:</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// * OpenCL&lt;space&gt;&lt;major_version.minor_version&gt;&lt;space&gt;&lt;platform-specific</span>
    <span class="doccomment">///   information&gt;</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// * The major_version.minor_version value returned will be &#39;1.2&#39;.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// * TODO: Convert this to new version system returning an `OpenclVersion`.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">version</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">OclCoreResult</span><span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span> {
        <span class="ident">core</span>::<span class="ident">get_platform_info</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>, <span class="ident">PlatformInfo</span>::<span class="ident">Version</span>).<span class="ident">map</span>(<span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">into</span>())
    }

    <span class="doccomment">/// Returns the platform name as a string.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">name</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">OclCoreResult</span><span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span> {
        <span class="ident">core</span>::<span class="ident">get_platform_info</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>, <span class="ident">PlatformInfo</span>::<span class="ident">Name</span>).<span class="ident">map</span>(<span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">into</span>())
    }

    <span class="doccomment">/// Returns the platform vendor as a string.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">vendor</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">OclCoreResult</span><span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span> {
        <span class="ident">core</span>::<span class="ident">get_platform_info</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>, <span class="ident">PlatformInfo</span>::<span class="ident">Vendor</span>).<span class="ident">map</span>(<span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">into</span>())
    }

    <span class="doccomment">/// Returns the list of platform extensions.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Extensions defined here must be supported by all devices associated</span>
    <span class="doccomment">/// with this platform.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">extensions</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">OclCoreResult</span><span class="op">&lt;</span><span class="ident">Extensions</span><span class="op">&gt;</span> {
        <span class="kw">let</span> <span class="ident">extensions</span> <span class="op">=</span> <span class="ident">core</span>::<span class="ident">get_platform_info</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>, <span class="ident">PlatformInfo</span>::<span class="ident">Extensions</span>);
        <span class="ident">extensions</span>.<span class="ident">map</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> <span class="ident">Extensions</span> { <span class="ident">inner</span>: <span class="ident">e</span>.<span class="ident">into</span>() })
    }

    <span class="doccomment">/// Returns a reference to the underlying `PlatformIdCore`.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_core</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="ident">PlatformIdCore</span> {
        <span class="kw-2">&amp;</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">&amp;</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&amp;</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">-&gt;</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">&quot;Platform&quot;</span>)
            .<span class="ident">field</span>(<span class="string">&quot;Profile&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">PlatformInfo</span>::<span class="ident">Profile</span>))
            .<span class="ident">field</span>(<span class="string">&quot;Version&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">PlatformInfo</span>::<span class="ident">Version</span>))
            .<span class="ident">field</span>(<span class="string">&quot;Name&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">PlatformInfo</span>::<span class="ident">Name</span>))
            .<span class="ident">field</span>(<span class="string">&quot;Vendor&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">PlatformInfo</span>::<span class="ident">Vendor</span>))
            .<span class="ident">field</span>(<span class="string">&quot;Extensions&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">info</span>(<span class="ident">PlatformInfo</span>::<span class="ident">Extensions</span>))
            .<span class="ident">finish</span>()
    }
}

<span class="kw">unsafe</span> <span class="kw">impl</span> <span class="ident">ClPlatformIdPtr</span> <span class="kw">for</span> <span class="ident">Platform</span> {
    <span class="kw">fn</span> <span class="ident">as_ptr</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">cl_platform_id</span> {
        <span class="self">self</span>.<span class="number">0</span>.<span class="ident">as_ptr</span>()
    }
}
<span class="comment">// unsafe impl&lt;&#39;a&gt; ClPlatformIdPtr for &amp;&#39;a Platform {}</span>

<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">Platform</span> {
    <span class="doccomment">/// Returns the first (0th) platform available, or the platform specified</span>
    <span class="doccomment">/// by the `OCL_DEFAULT_PLATFORM_IDX` environment variable if it is set.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// ### Panics</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Panics upon any OpenCL API error.</span>
    <span class="doccomment">///</span>
    <span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-&gt;</span> <span class="ident">Platform</span> {
        <span class="kw">let</span> <span class="ident">dflt_plat_core</span> <span class="op">=</span> <span class="ident">core</span>::<span class="ident">default_platform</span>().<span class="ident">expect</span>(<span class="string">&quot;Platform::default()&quot;</span>);
        <span class="ident">Platform</span>::<span class="ident">new</span>(<span class="ident">dflt_plat_core</span>)
    }
}

<span class="kw">impl</span> <span class="ident">From</span><span class="op">&lt;</span><span class="ident">PlatformIdCore</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">Platform</span> {
    <span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">core</span>: <span class="ident">PlatformIdCore</span>) <span class="op">-&gt;</span> <span class="ident">Platform</span> {
        <span class="ident">Platform</span>(<span class="ident">core</span>)
    }
}

<span class="kw">impl</span> <span class="ident">From</span><span class="op">&lt;</span><span class="ident">Platform</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">String</span> {
    <span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">p</span>: <span class="ident">Platform</span>) <span class="op">-&gt;</span> <span class="ident">String</span> {
        <span class="macro">format</span><span class="macro">!</span>(<span class="string">&quot;{}&quot;</span>, <span class="ident">p</span>)
    }
}

<span class="kw">impl</span> <span class="ident">From</span><span class="op">&lt;</span><span class="ident">Platform</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">PlatformIdCore</span> {
    <span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">p</span>: <span class="ident">Platform</span>) <span class="op">-&gt;</span> <span class="ident">PlatformIdCore</span> {
        <span class="ident">p</span>.<span class="number">0</span>
    }
}

<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> <span class="ident">From</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="ident">Platform</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">PlatformIdCore</span> {
    <span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">p</span>: <span class="kw-2">&amp;</span><span class="ident">Platform</span>) <span class="op">-&gt;</span> <span class="ident">PlatformIdCore</span> {
        <span class="ident">p</span>.<span class="number">0</span>.<span class="ident">clone</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">Platform</span> {
    <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&amp;</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">-&gt;</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">Platform</span> {
    <span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">PlatformIdCore</span>;

    <span class="kw">fn</span> <span class="ident">deref</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="ident">PlatformIdCore</span> {
        <span class="kw-2">&amp;</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">Platform</span> {
    <span class="kw">fn</span> <span class="ident">deref_mut</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">PlatformIdCore</span> {
        <span class="kw-2">&amp;</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><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>&#9166;</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>