<!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 `Queue` struct in crate `ocl`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Queue">
<title>ocl::Queue - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</head>
<body class="rustdoc 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">
<p class='location'><a href='index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'Queue', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>ocl</a>::<wbr><a class="struct" href=''>Queue</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'>−</span>]
</a>
</span><a class='srclink' href='../src/ocl/standard/queue.rs.html#20-23' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Queue { /* fields omitted */ }</pre><div class='docblock'><p>A command queue which manages all actions taken on kernels, buffers, and
images.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#25-100' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>(<br> context: &<a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a>, <br> device: <a class="struct" href="../ocl/struct.Device.html" title="struct ocl::Device">Device</a>, <br> properties: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../ocl/flags/struct.CommandQueueProperties.html" title="struct ocl::flags::CommandQueueProperties">CommandQueueProperties</a>><br>) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a><<a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>></code></span></h4>
<div class='docblock'><p>Returns a new Queue on the device specified by <code>device</code>.</p>
</div><h4 id='method.flush' class="method"><span id='flush.v' class='invisible'><code>fn <a href='#method.flush' class='fnname'>flush</a>(&self) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
<div class='docblock'><p>Issues all previously queued OpenCL commands to the device.</p>
</div><h4 id='method.finish' class="method"><span id='finish.v' class='invisible'><code>fn <a href='#method.finish' class='fnname'>finish</a>(&self) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
<div class='docblock'><p>Blocks until all commands in this queue have completed before returning.</p>
</div><h4 id='method.enqueue_marker' class="method"><span id='enqueue_marker.v' class='invisible'><code>fn <a href='#method.enqueue_marker' class='fnname'>enqueue_marker</a><Ewl>(&self, ewait: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Ewl>) -> <a class="type" href="../ocl/type.Result.html" title="type ocl::Result">OclResult</a><<a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>> <span class="where fmt-newline">where<br> Ewl: <a class="trait" href="../ocl_core/types/abs/trait.ClWaitListPtr.html" title="trait ocl_core::types::abs::ClWaitListPtr">ClWaitListPtr</a>, </span></code></span></h4>
<div class='docblock'><p>Enqueues a marker command which waits for either a list of events to
complete, or all previously enqueued commands to complete.</p>
</div><h4 id='method.core_as_ref' class="method"><span id='core_as_ref.v' class='invisible'><code>fn <a href='#method.core_as_ref' class='fnname'>core_as_ref</a>(&self) -> &<a class="struct" href="../ocl_core/types/abs/struct.CommandQueue.html" title="struct ocl_core::types::abs::CommandQueue">CommandQueueCore</a></code></span></h4>
<div class='stability'><div class='stab deprecated'>Deprecated since 0.13.0<p>: Use <code>::core</code> instead.</p>
</div></div><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.core' class="method"><span id='core.v' class='invisible'><code>fn <a href='#method.core' class='fnname'>core</a>(&self) -> &<a class="struct" href="../ocl_core/types/abs/struct.CommandQueue.html" title="struct ocl_core::types::abs::CommandQueue">CommandQueueCore</a></code></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.context' class="method"><span id='context.v' class='invisible'><code>fn <a href='#method.context' class='fnname'>context</a>(&self) -> <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code></span></h4>
<div class='docblock'><p>Returns a copy of the Context associated with this queue.</p>
</div><h4 id='method.device' class="method"><span id='device.v' class='invisible'><code>fn <a href='#method.device' class='fnname'>device</a>(&self) -> <a class="struct" href="../ocl/struct.Device.html" title="struct ocl::Device">Device</a></code></span></h4>
<div class='docblock'><p>Returns the <code>OpenCL</code> device associated with this queue.</p>
</div><h4 id='method.device_version' class="method"><span id='device_version.v' class='invisible'><code>fn <a href='#method.device_version' class='fnname'>device_version</a>(&self) -> <a class="struct" href="../ocl_core/types/structs/struct.OpenclVersion.html" title="struct ocl_core::types::structs::OpenclVersion">OpenclVersion</a></code></span></h4>
<div class='docblock'><p>Returns the cached device version.</p>
</div><h4 id='method.info' class="method"><span id='info.v' class='invisible'><code>fn <a href='#method.info' class='fnname'>info</a>(&self, info_kind: <a class="enum" href="../ocl/enums/enum.CommandQueueInfo.html" title="enum ocl::enums::CommandQueueInfo">CommandQueueInfo</a>) -> <a class="enum" href="../ocl/enums/enum.CommandQueueInfoResult.html" title="enum ocl::enums::CommandQueueInfoResult">CommandQueueInfoResult</a></code></span></h4>
<div class='docblock'><p>Returns info about this queue.</p>
</div></div><h2 id='deref-methods'>Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html" title="trait core::ops::Deref">Deref</a><Target = <a class="struct" href="../ocl_core/types/abs/struct.CommandQueue.html" title="struct ocl_core::types::abs::CommandQueue">CommandQueueCore</a>></h2><div class='impl-items'><h4 id='method.as_ptr' class="method"><span id='as_ptr.v' class='invisible'><code>fn <a href='#method.as_ptr' class='fnname'>as_ptr</a>(&self) -> <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></h4>
<div class='docblock'><p>Returns a pointer, do not store it.</p>
</div><h4 id='method.device-1' class="method"><span id='device.v-1' class='invisible'><code>fn <a href='#method.device-1' class='fnname'>device</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../ocl_core/types/abs/struct.DeviceId.html" title="struct ocl_core::types::abs::DeviceId">DeviceId</a>, <a class="enum" href="../ocl/enum.Error.html" title="enum ocl::Error">Error</a>></code></span></h4>
<div class='docblock'><p>Returns the <code>DeviceId</code> associated with this command queue.</p>
</div><h4 id='method.context-1' class="method"><span id='context.v-1' class='invisible'><code>fn <a href='#method.context-1' class='fnname'>context</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../ocl_core/types/abs/struct.Context.html" title="struct ocl_core::types::abs::Context">Context</a>, <a class="enum" href="../ocl/enum.Error.html" title="enum ocl::Error">Error</a>></code></span></h4>
<div class='docblock'><p>Returns the <code>Context</code> associated with this command queue.</p>
</div><h4 id='method.context_ptr' class="method"><span id='context_ptr.v' class='invisible'><code>fn <a href='#method.context_ptr' class='fnname'>context_ptr</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>, <a class="enum" href="../ocl/enum.Error.html" title="enum ocl::Error">Error</a>></code></span></h4>
<div class='docblock'><p>Returns the <code>cl_context</code> associated with this command queue.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 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.Queue.html" title="struct ocl::Queue">Queue</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#19' 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>(&self) -> <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a></code></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>(&mut self, source: &Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></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 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.Queue.html" title="struct ocl::Queue">Queue</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#19' 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>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 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.Queue.html" title="struct ocl::Queue">Queue</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#102-106' 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>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></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 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>> for <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#108-112' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.as_ref' class="method"><span id='as_ref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html#tymethod.as_ref' class='fnname'>as_ref</a>(&self) -> &<a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a></code></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="../ocl_core/types/abs/struct.CommandQueue.html" title="struct ocl_core::types::abs::CommandQueue">CommandQueueCore</a>> for <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#114-118' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.as_ref-1' class="method"><span id='as_ref.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html#tymethod.as_ref' class='fnname'>as_ref</a>(&self) -> &<a class="struct" href="../ocl_core/types/abs/struct.CommandQueue.html" title="struct ocl_core::types::abs::CommandQueue">CommandQueueCore</a></code></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html" title="trait core::ops::Deref">Deref</a> for <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#120-126' 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/trait.Deref.html#associatedtype.Target' class="type">Target</a> = <a class="struct" href="../ocl_core/types/abs/struct.CommandQueue.html" title="struct ocl_core::types::abs::CommandQueue">CommandQueueCore</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/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&self) -> &<a class="struct" href="../ocl_core/types/abs/struct.CommandQueue.html" title="struct ocl_core::types::abs::CommandQueue">CommandQueueCore</a></code></span></h4>
<div class='docblock'><p>The method called to dereference a value</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.DerefMut.html" title="trait core::ops::DerefMut">DerefMut</a> for <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#128-132' 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/trait.DerefMut.html#tymethod.deref_mut' class='fnname'>deref_mut</a>(&mut self) -> &mut <a class="struct" href="../ocl_core/types/abs/struct.CommandQueue.html" title="struct ocl_core::types::abs::CommandQueue">CommandQueueCore</a></code></span></h4>
<div class='docblock'><p>The method called to mutably dereference a value</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<'a> <a class="trait" href="../ocl_core/types/abs/trait.ClContextPtr.html" title="trait ocl_core::types::abs::ClContextPtr">ClContextPtr</a> for &'a <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#134-139' 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>(&self) -> <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></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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "ocl";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>