RONCC
/
HPC-Tools-for-Quantum-Computing


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
							<!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="API documentation for the Rust `Context` struct in crate `ocl`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, Context">

    <title>ocl::Context - Rust</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 struct">
    <!--[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>
        
        <p class='location'>Struct Context</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.builder">builder</a><a href="#method.new">new</a><a href="#method.resolve_wrapping_device_idxs">resolve_wrapping_device_idxs</a><a href="#method.get_device_by_wrapping_index">get_device_by_wrapping_index</a><a href="#method.platform_info">platform_info</a><a href="#method.device_info">device_info</a><a href="#method.info">info</a><a href="#method.as_core">as_core</a><a href="#method.devices">devices</a><a href="#method.device_versions">device_versions</a><a href="#method.platform">platform</a></div><a class="sidebar-title" href="#deref-methods">Methods from Deref&lt;Target=ContextCore&gt;</a><div class="sidebar-links"><a href="#method.as_ptr">as_ptr</a><a href="#method.devices">devices</a><a href="#method.platform">platform</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Clone">Clone</a><a href="#impl-From%3CContextCore%3E">From&lt;ContextCore&gt;</a><a href="#impl-Display">Display</a><a href="#impl-Deref">Deref</a><a href="#impl-DerefMut">DerefMut</a><a href="#impl-ClContextPtr">ClContextPtr</a><a href="#impl-ClVersions">ClVersions</a></div></div><p class='location'><a href='index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'Context', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></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">
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>ocl</a>::<wbr><a class="struct" href=''>Context</a></span><span class='out-of-band'><span id='render-detail'>
                   <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
                       [<span class='inner'>&#x2212;</span>]
                   </a>
               </span><a class='srclink' href='../src/ocl/standard/context.rs.html#27' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Context(_);</pre><div class='docblock'><p>A context for a particular platform and set of device types.</p>
<p>Thread safety and destruction for any enclosed pointers are all handled automatically.
Clone, store, and share between threads to your heart's content.</p>
</div>
                    <h2 id='methods' class='small-section-header'>
                      Methods<a href='#methods' class='anchor'></a>
                    </h2>
                <h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#29-160' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.builder' class="method"><span id='builder.v' class='invisible'><code>pub fn <a href='#method.builder' class='fnname'>builder</a>() -&gt; <a class="struct" href="../ocl/builders/struct.ContextBuilder.html" title="struct ocl::builders::ContextBuilder">ContextBuilder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#33-35' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a <a href="/ocl/ocl/struct.ContextBuilder.html"><code>ContextBuilder</code></a>.</p>
<p>This is the preferred way to create a Context.</p>
</div><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;properties: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../ocl/builders/struct.ContextProperties.html" title="struct ocl::builders::ContextProperties">ContextProperties</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;device_spec: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="../ocl/builders/enum.DeviceSpecifier.html" title="enum ocl::builders::DeviceSpecifier">DeviceSpecifier</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;pfn_notify: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../ocl_core/type.CreateContextCallbackFn.html" title="type ocl_core::CreateContextCallbackFn">CreateContextCallbackFn</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;user_data: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../ocl_core/type.UserDataPtr.html" title="type ocl_core::UserDataPtr">UserDataPtr</a>&gt;<br>) -&gt; <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#60-81' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a newly created context.</p>
<p>Prefer <code>Context::builder()...</code> instead of this method unless you know
what you're doing. Please also immediately contact us if you do, in
fact, know what you're doing so that you can be added to the
development team as the one who does.</p>
<h2 id="defaults" class="section-header"><a href="#defaults">Defaults</a></h2>
<ul>
<li>The 'NULL' platform (which is not to be relied on but is generally
the first avaliable).</li>
<li>All devices associated with the 'NULL' platform</li>
<li>No notify callback function or user data.</li>
</ul>
<p>Don't rely on these defaults, instead rely on the <code>ContextBuilder</code>
defaults. In other words, use: <code>Context::builder().build().unwrap()</code>
rather than <code>Context::new(None, None, None, None).unwrap()</code>.</p>
<h2 id="panics" class="section-header"><a href="#panics">Panics</a></h2>
<p>[TEMPORARY] Passing a <code>Some</code> variant for <code>pfn_notify</code> or <code>user_data</code> is
not yet supported. File an issue if you need this.</p>
</div><h4 id='method.resolve_wrapping_device_idxs' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;</h3><code class="content"><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;</span></code></div></div><span id='resolve_wrapping_device_idxs.v' class='invisible'><code>pub fn <a href='#method.resolve_wrapping_device_idxs' class='fnname'>resolve_wrapping_device_idxs</a>(&amp;self, idxs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../ocl/struct.Device.html" title="struct ocl::Device">Device</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#88-90' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Resolves a list of zero-based device indices into a list of Devices.</p>
<p>If any index is out of bounds it will wrap around zero (%) to the next
valid device index.</p>
</div><h4 id='method.get_device_by_wrapping_index' class="method"><span id='get_device_by_wrapping_index.v' class='invisible'><code>pub fn <a href='#method.get_device_by_wrapping_index' class='fnname'>get_device_by_wrapping_index</a>(&amp;self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="struct" href="../ocl/struct.Device.html" title="struct ocl::Device">Device</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#96-98' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a device by its ordinal count within this context.</p>
<p>Round-robins (%) to the next valid device.</p>
</div><h4 id='method.platform_info' class="method"><span id='platform_info.v' class='invisible'><code>pub fn <a href='#method.platform_info' class='fnname'>platform_info</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;info_kind: <a class="enum" href="../ocl/enums/enum.PlatformInfo.html" title="enum ocl::enums::PlatformInfo">PlatformInfo</a><br>) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="enum" href="../ocl/enums/enum.PlatformInfoResult.html" title="enum ocl::enums::PlatformInfoResult">PlatformInfoResult</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#101-110' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns info about the platform associated with the context.</p>
</div><h4 id='method.device_info' class="method"><span id='device_info.v' class='invisible'><code>pub fn <a href='#method.device_info' class='fnname'>device_info</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;info_kind: <a class="enum" href="../ocl/enums/enum.DeviceInfo.html" title="enum ocl::enums::DeviceInfo">DeviceInfo</a><br>) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="enum" href="../ocl/enums/enum.DeviceInfoResult.html" title="enum ocl::enums::DeviceInfoResult">DeviceInfoResult</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#114-121' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns info about the device indexed by <code>index</code> associated with this
context.</p>
</div><h4 id='method.info' class="method"><span id='info.v' class='invisible'><code>pub fn <a href='#method.info' class='fnname'>info</a>(&amp;self, info_kind: <a class="enum" href="../ocl/enums/enum.ContextInfo.html" title="enum ocl::enums::ContextInfo">ContextInfo</a>) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="enum" href="../ocl/enums/enum.ContextInfoResult.html" title="enum ocl::enums::ContextInfoResult">ContextInfoResult</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#124-126' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns info about the context.</p>
</div><h4 id='method.as_core' class="method"><span id='as_core.v' class='invisible'><code>pub fn <a href='#method.as_core' class='fnname'>as_core</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.Context.html" title="struct ocl_core::types::abs::Context">ContextCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#131-133' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a reference to the core pointer wrapper, usable by functions in
the <code>core</code> module.</p>
</div><h4 id='method.devices' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;</h3><code class="content"><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;</span></code></div></div><span id='devices.v' class='invisible'><code>pub fn <a href='#method.devices' class='fnname'>devices</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../ocl/struct.Device.html" title="struct ocl::Device">Device</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#138-140' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the list of devices associated with this context.</p>
<p>Panics upon any OpenCL error.</p>
</div><h4 id='method.device_versions' class="method"><span id='device_versions.v' class='invisible'><code>pub fn <a href='#method.device_versions' class='fnname'>device_versions</a>(&amp;self) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../ocl_core/types/structs/struct.OpenclVersion.html" title="struct ocl_core::types::structs::OpenclVersion">OpenclVersion</a>&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#143-145' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the list of device versions associated with this context.</p>
</div><h4 id='method.platform' class="method"><span id='platform.v' class='invisible'><code>pub fn <a href='#method.platform' class='fnname'>platform</a>(&amp;self) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../ocl/struct.Platform.html" title="struct ocl::Platform">Platform</a>&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#148-150' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the platform this context is associated with.</p>
</div></div>
                    <h2 id='deref-methods' class='small-section-header'>
                      Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>&lt;Target = <a class="struct" href="../ocl_core/types/abs/struct.Context.html" title="struct ocl_core::types::abs::Context">ContextCore</a>&gt;<a href='#deref-methods' class='anchor'></a>
                    </h2>
                <div class='impl-items'><h4 id='method.as_ptr' class="method"><span id='as_ptr.v' class='invisible'><code>pub fn <a href='#method.as_ptr' class='fnname'>as_ptr</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../libc/enum.c_void.html" title="enum libc::c_void">c_void</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl_core/types/abs.rs.html#493-495' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a pointer, do not store it.</p>
</div><h4 id='method.devices-1' class="method"><span id='devices.v-1' class='invisible'><code>pub fn <a href='#method.devices-1' class='fnname'>devices</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../ocl_core/types/abs/struct.DeviceId.html" title="struct ocl_core::types::abs::DeviceId">DeviceId</a>&gt;, <a class="struct" href="../ocl_core/error/struct.Error.html" title="struct ocl_core::error::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl_core/types/abs.rs.html#498-504' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the devices associated with this context.</p>
</div><h4 id='method.platform-1' class="method"><span id='platform.v-1' class='invisible'><code>pub fn <a href='#method.platform-1' class='fnname'>platform</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../ocl_core/types/abs/struct.PlatformId.html" title="struct ocl_core::types::abs::PlatformId">PlatformId</a>&gt;, <a class="struct" href="../ocl_core/error/struct.Error.html" title="struct ocl_core::error::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl_core/types/abs.rs.html#511-513' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the platform associated with this context, if any.</p>
<p>Errors upon the usual OpenCL errors.</p>
<p>Returns <code>None</code> if the context properties do not specify a platform.</p>
</div></div>
            <h2 id='implementations' class='small-section-header'>
              Trait Implementations<a href='#implementations' class='anchor'></a>
            </h2>
        <h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#26' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#26' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#26' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#26' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-From%3CContextCore%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="struct" href="../ocl_core/types/abs/struct.Context.html" title="struct ocl_core::types::abs::Context">ContextCore</a>&gt; for <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code><a href='#impl-From%3CContextCore%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#162-166' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(c: <a class="struct" href="../ocl_core/types/abs/struct.Context.html" title="struct ocl_core::types::abs::Context">ContextCore</a>) -&gt; <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#163-165' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Display' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code><a href='#impl-Display' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#168-172' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#169-171' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Deref' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code><a href='#impl-Deref' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#174-180' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.Target' class="type"><span id='Target.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target' class="type">Target</a> = <a class="struct" href="../ocl_core/types/abs/struct.Context.html" title="struct ocl_core::types::abs::Context">ContextCore</a></code></span></h4>
<div class='docblock'><p>The resulting type after dereferencing.</p>
</div><h4 id='method.deref' class="method"><span id='deref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.Context.html" title="struct ocl_core::types::abs::Context">ContextCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#177-179' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Dereferences the value.</p>
</div></div><h3 id='impl-DerefMut' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> for <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code><a href='#impl-DerefMut' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#182-186' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.deref_mut' class="method"><span id='deref_mut.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html#tymethod.deref_mut' class='fnname'>deref_mut</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="../ocl_core/types/abs/struct.Context.html" title="struct ocl_core::types::abs::Context">ContextCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#183-185' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Mutably dereferences the value.</p>
</div></div><h3 id='impl-ClContextPtr' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="../ocl_core/types/abs/trait.ClContextPtr.html" title="trait ocl_core::types::abs::ClContextPtr">ClContextPtr</a> for &amp;'a <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code><a href='#impl-ClContextPtr' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#188-192' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.as_ptr-1' class="method"><span id='as_ptr.v-1' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.ClContextPtr.html#tymethod.as_ptr' class='fnname'>as_ptr</a>(&amp;self) -&gt; <a class="type" href="../cl_sys/cl_h/type.cl_context.html" title="type cl_sys::cl_h::cl_context">cl_context</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#189-191' title='goto source code'>[src]</a></span></h4>
</div><h3 id='impl-ClVersions' class='impl'><span class='in-band'><code>impl <a class="trait" href="../ocl_core/types/abs/trait.ClVersions.html" title="trait ocl_core::types::abs::ClVersions">ClVersions</a> for <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code><a href='#impl-ClVersions' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#194-197' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.device_versions-1' class="method"><span id='device_versions.v-1' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.ClVersions.html#tymethod.device_versions' class='fnname'>device_versions</a>(&amp;self) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../ocl_core/types/structs/struct.OpenclVersion.html" title="struct ocl_core::types::structs::OpenclVersion">OpenclVersion</a>&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#195' title='goto source code'>[src]</a></span></h4>
<h4 id='method.platform_version' class="method"><span id='platform_version.v' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.ClVersions.html#tymethod.platform_version' class='fnname'>platform_version</a>(&amp;self) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="struct" href="../ocl_core/types/structs/struct.OpenclVersion.html" title="struct ocl_core::types::structs::OpenclVersion">OpenclVersion</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#196' title='goto source code'>[src]</a></span></h4>
<h4 id='method.verify_device_versions' class="method"><span id='verify_device_versions.v' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.ClVersions.html#method.verify_device_versions' class='fnname'>verify_device_versions</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;required_version: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 2]</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../ocl_core/error/struct.Error.html" title="struct ocl_core::error::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl_core/types/abs.rs.html#128-131' title='goto source code'>[src]</a></span></h4>
<h4 id='method.verify_platform_version' class="method"><span id='verify_platform_version.v' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.ClVersions.html#method.verify_platform_version' class='fnname'>verify_platform_version</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;required_version: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 2]</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../ocl_core/error/struct.Error.html" title="struct ocl_core::error::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl_core/types/abs.rs.html#133-137' title='goto source code'>[src]</a></span></h4>
</div><h3 id='impl-ClVersions-1' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="../ocl_core/types/abs/trait.ClVersions.html" title="trait ocl_core::types::abs::ClVersions">ClVersions</a> for &amp;'a <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code><a href='#impl-ClVersions-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#199-202' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.device_versions-2' class="method"><span id='device_versions.v-2' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.ClVersions.html#tymethod.device_versions' class='fnname'>device_versions</a>(&amp;self) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../ocl_core/types/structs/struct.OpenclVersion.html" title="struct ocl_core::types::structs::OpenclVersion">OpenclVersion</a>&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#200' title='goto source code'>[src]</a></span></h4>
<h4 id='method.platform_version-1' class="method"><span id='platform_version.v-1' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.ClVersions.html#tymethod.platform_version' class='fnname'>platform_version</a>(&amp;self) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="struct" href="../ocl_core/types/structs/struct.OpenclVersion.html" title="struct ocl_core::types::structs::OpenclVersion">OpenclVersion</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/context.rs.html#201' title='goto source code'>[src]</a></span></h4>
<h4 id='method.verify_device_versions-1' class="method"><span id='verify_device_versions.v-1' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.ClVersions.html#method.verify_device_versions' class='fnname'>verify_device_versions</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;required_version: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 2]</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../ocl_core/error/struct.Error.html" title="struct ocl_core::error::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl_core/types/abs.rs.html#128-131' title='goto source code'>[src]</a></span></h4>
<h4 id='method.verify_platform_version-1' class="method"><span id='verify_platform_version.v-1' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.ClVersions.html#method.verify_platform_version' class='fnname'>verify_platform_version</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;required_version: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 2]</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../ocl_core/error/struct.Error.html" title="struct ocl_core::error::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl_core/types/abs.rs.html#133-137' title='goto source code'>[src]</a></span></h4>
</div></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>