<!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 `BufferReadCmd` struct in crate `ocl`.">
<meta name="keywords" content="rust, rustlang, rust-lang, BufferReadCmd">
<title>ocl::builders::BufferReadCmd - 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>::<wbr><a href='index.html'>builders</a></p><script>window.sidebarCurrent = {name: 'BufferReadCmd', 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 href='index.html'>builders</a>::<wbr><a class="struct" href=''>BufferReadCmd</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/buffer.rs.html#605-609' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'><div class="docblock attributes">#[must_use = "commands do nothing unless enqueued"]
</div>pub struct BufferReadCmd<'c, 'd, T> <span class="where fmt-newline">where<br> T: 'c + 'd, </span> { /* fields omitted */ }</pre><div class='docblock'><p>A buffer command builder used to enqueue reads.</p>
<p>See <a href="https://www.khronos.org/registry/OpenCL/sdk/1.2/docs/man/xhtml/clEnqueueReadBuffer.html">SDK</a> docs for more details.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl<'c, 'd, T> <a class="struct" href="../../ocl/builders/struct.BufferReadCmd.html" title="struct ocl::builders::BufferReadCmd">BufferReadCmd</a><'c, 'd, T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/buffer.rs.html#611-875' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.queue' class="method"><span id='queue.v' class='invisible'><code>fn <a href='#method.queue' class='fnname'>queue</a>(self, queue: &'c <a class="struct" href="../../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>) -> <a class="struct" href="../../ocl/builders/struct.BufferReadCmd.html" title="struct ocl::builders::BufferReadCmd">BufferReadCmd</a><'c, 'd, T></code></span></h4>
<div class='docblock'><p>Specifies a queue to use for this call only.</p>
</div><h4 id='method.block' class="method"><span id='block.v' class='invisible'><code>unsafe fn <a href='#method.block' class='fnname'>block</a>(self, block: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../../ocl/builders/struct.BufferReadCmd.html" title="struct ocl::builders::BufferReadCmd">BufferReadCmd</a><'c, 'd, T></code></span></h4>
<div class='docblock'><p>Specifies whether or not to block the current thread until completion.</p>
<p>Ignored if this is not a read or write operation.</p>
<p>Default is <code>block = true</code>.</p>
<h2 id="safety" class="section-header"><a href="#safety">Safety</a></h2>
<p>When performing non-blocking reads or writes, the caller must ensure
that the data being read from or written to is not accessed improperly
until the command completes. Use events (<code>Event::wait_for</code>) or the
command queue (<code>Queue::finish</code>) to synchronize.</p>
<p>If possible, prefer instead to use <a href="struct.BufferMapCmd.html"><code>::map</code></a> with <a href="struct.BufferMapCmd.html"><code>::enq_async</code></a> for
optimal performance and data integrity.</p>
</div><h4 id='method.offset' class="method"><span id='offset.v' class='invisible'><code>fn <a href='#method.offset' class='fnname'>offset</a>(self, offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../../ocl/builders/struct.BufferReadCmd.html" title="struct ocl::builders::BufferReadCmd">BufferReadCmd</a><'c, 'd, T></code></span></h4>
<div class='docblock'><p>Sets the linear offset for an operation.</p>
<h2 id="panics" class="section-header"><a href="#panics">Panics</a></h2>
<p>The 'shape' may not have already been set to rectangular by the
<code>::rect</code> function.</p>
</div><h4 id='method.dst_offset' class="method"><span id='dst_offset.v' class='invisible'><code>fn <a href='#method.dst_offset' class='fnname'>dst_offset</a>(self, dst_offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../../ocl/builders/struct.BufferReadCmd.html" title="struct ocl::builders::BufferReadCmd">BufferReadCmd</a><'c, 'd, T></code></span></h4>
<div class='docblock'><p>Sets an offset into the destination data.</p>
<p>Equivalent to setting the start position of a slice into the
destination data (e.g. <code>dst_data[dst_offset..]</code>). Use <code>::len</code> to set
the end position (resulting in <code>dst_data[dst_offset..len]</code>).</p>
<p>Defaults to 0 if not set. Panics if <code>::rect</code> has been called.</p>
</div><h4 id='method.len' class="method"><span id='len.v' class='invisible'><code>fn <a href='#method.len' class='fnname'>len</a>(self, len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../../ocl/builders/struct.BufferReadCmd.html" title="struct ocl::builders::BufferReadCmd">BufferReadCmd</a><'c, 'd, T></code></span></h4>
<div class='docblock'><p>Sets the total length of data to read.</p>
<p>Equivalent to setting the end position of a slice into the destination
data (e.g. <code>destination[..len]</code>). Use <code>::dst_offset</code> to set the start
position (resulting in <code>dst_data[dst_offset..len]</code>).</p>
<p>Defaults to the total length of the read destination provided. Panics
if <code>::rect</code> has been called.</p>
</div><h4 id='method.rect' class="method"><span id='rect.v' class='invisible'><code>fn <a href='#method.rect' class='fnname'>rect</a>(<br> self, <br> src_origin: <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.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>, <br> dst_origin: <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.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>, <br> region: <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.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>, <br> src_row_pitch_bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> src_slc_pitch_bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> dst_row_pitch_bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> dst_slc_pitch_bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -> <a class="struct" href="../../ocl/builders/struct.BufferReadCmd.html" title="struct ocl::builders::BufferReadCmd">BufferReadCmd</a><'c, 'd, T></code></span></h4>
<div class='docblock'><p>Specifies that this will be a rectangularly shaped operation
(the default being linear).</p>
<p>Row and slice pitches must all be expressed in bytes.</p>
<p>Panics if <code>:offset</code>, <code>dst_offset</code>, or <code>::len</code> have been called.</p>
</div><h4 id='method.ewait' class="method"><span id='ewait.v' class='invisible'><code>fn <a href='#method.ewait' class='fnname'>ewait</a><'e, Ewl>(self, ewait: Ewl) -> <a class="struct" href="../../ocl/builders/struct.BufferReadCmd.html" title="struct ocl::builders::BufferReadCmd">BufferReadCmd</a><'c, 'd, T> <span class="where fmt-newline">where<br> 'e: 'c,<br> Ewl: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../ocl/builders/enum.ClWaitListPtrEnum.html" title="enum ocl::builders::ClWaitListPtrEnum">ClWaitListPtrEnum</a><'e>>, </span></code></span></h4>
<div class='docblock'><p>Specifies a list of events to wait on before the command will run.</p>
</div><h4 id='method.ewait_opt' class="method"><span id='ewait_opt.v' class='invisible'><code>fn <a href='#method.ewait_opt' class='fnname'>ewait_opt</a><'e, 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="struct" href="../../ocl/builders/struct.BufferReadCmd.html" title="struct ocl::builders::BufferReadCmd">BufferReadCmd</a><'c, 'd, T> <span class="where fmt-newline">where<br> 'e: 'c,<br> Ewl: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../ocl/builders/enum.ClWaitListPtrEnum.html" title="enum ocl::builders::ClWaitListPtrEnum">ClWaitListPtrEnum</a><'e>>, </span></code></span></h4>
<div class='docblock'><p>Specifies a list of events to wait on before the command will run or
resets it to <code>None</code>.</p>
</div><h4 id='method.enew' class="method"><span id='enew.v' class='invisible'><code>fn <a href='#method.enew' class='fnname'>enew</a><'e, En>(self, enew: En) -> <a class="struct" href="../../ocl/builders/struct.BufferReadCmd.html" title="struct ocl::builders::BufferReadCmd">BufferReadCmd</a><'c, 'd, T> <span class="where fmt-newline">where<br> 'e: 'c,<br> En: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../ocl/builders/enum.ClNullEventPtrEnum.html" title="enum ocl::builders::ClNullEventPtrEnum">ClNullEventPtrEnum</a><'e>>, </span></code></span></h4>
<div class='docblock'><p>Specifies the destination for a new, optionally created event
associated with this command.</p>
</div><h4 id='method.enew_opt' class="method"><span id='enew_opt.v' class='invisible'><code>fn <a href='#method.enew_opt' class='fnname'>enew_opt</a><'e, En>(self, enew: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><En>) -> <a class="struct" href="../../ocl/builders/struct.BufferReadCmd.html" title="struct ocl::builders::BufferReadCmd">BufferReadCmd</a><'c, 'd, T> <span class="where fmt-newline">where<br> 'e: 'c,<br> En: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../ocl/builders/enum.ClNullEventPtrEnum.html" title="enum ocl::builders::ClNullEventPtrEnum">ClNullEventPtrEnum</a><'e>>, </span></code></span></h4>
<div class='docblock'><p>Specifies a destination for a new, optionally created event
associated with this command or resets it to <code>None</code>.</p>
</div><h4 id='method.enq' class="method"><span id='enq.v' class='invisible'><code>fn <a href='#method.enq' class='fnname'>enq</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>Enqueues this command, blocking the current thread until it is complete.</p>
<p>If an <code>RwVec</code> is being used as the data destination, the current
thread will be blocked until an exclusive lock can be obtained before
running the command (which will also block for its duration).</p>
</div><h4 id='method.enq_async' class="method"><span id='enq_async.v' class='invisible'><code>fn <a href='#method.enq_async' class='fnname'>enq_async</a>(self) -> <a class="type" href="../../ocl/type.Result.html" title="type ocl::Result">OclResult</a><<a class="struct" href="../../ocl/struct.FutureRwGuard.html" title="struct ocl::FutureRwGuard">FutureRwGuard</a><T, <a class="struct" href="../../ocl/struct.WriteGuard.html" title="struct ocl::WriteGuard">WriteGuard</a><T>>></code></span></h4>
<div class='docblock'><p>Enqueues this command and returns a future representing its completion
which resolves to a guard providing exclusive data access usable
within subsequent futures.</p>
<p>A data destination container appropriate for an asynchronous operation
(such as <code>RwVec</code>) must have been passed to <code>::read</code>.</p>
</div></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>