1234567891011121314151617181920212223242526272829303132333435363738 |
- <!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 `OrderLock` struct in crate `ocl`."><meta name="keywords" content="rust, rustlang, rust-lang, OrderLock"><title>ocl::async::OrderLock - 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="../../light.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">☰</div><p class='location'>Struct OrderLock</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.read">read</a><a href="#method.write">write</a><a href="#method.as_ptr">as_ptr</a><a href="#method.as_mut_ptr">as_mut_ptr</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-From%3CQrwLock%3CV%3E%3E">From<QrwLock<V>></a><a href="#impl-From%3CV%3E">From<V></a><a href="#impl-Clone">Clone</a><a href="#impl-From%3COrderLock%3CInner%3CT%3E%3E%3E">From<OrderLock<Inner<T>>></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>ocl</a>::<wbr><a href='index.html'>async</a></p><script>window.sidebarCurrent = {name: 'OrderLock', 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"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></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'>async</a>::<wbr><a class="struct" href=''>OrderLock</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/async/order_lock.rs.html#793-795' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct OrderLock<V> { /* fields omitted */ }</pre></div><div class='docblock'><p>A lock with conserved global order which interoperates with OpenCL events
- and Rust futures to provide exclusive access to data.</p>
- <p>Calling <code>::read</code> or <code>::write</code> returns a future which will resolve into a
- <code>OrderGuard</code>.</p>
- <h2 id="platform-compatibility" class="section-header"><a href="#platform-compatibility">Platform Compatibility</a></h2>
- <p>Some CPU device/platform combinations have synchronization problems when
- accessing an <code>OrderLock</code> from multiple threads. Known platforms with problems
- are 2nd and 4th gen Intel Core processors (Sandy Bridge and Haswell) with
- Intel OpenCL CPU drivers. Others may be likewise affected. Run the
- <code>device_check.rs</code> example to determine if your device/platform is
- affected. AMD platform drivers are known to work properly on the
- aforementioned CPUs so use those instead if possible.</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'><table class='table-display'><tbody><tr><td><code>impl<V> <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#797-841' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(data: V) -> <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#800-804' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates and returns a new <code>OrderLock</code>.</p>
- </div><h4 id='method.read' class="method"><span id='read.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.read' class='fnname'>read</a>(self) -> <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><V, <a class="struct" href="../../ocl/struct.ReadGuard.html" title="struct ocl::ReadGuard">ReadGuard</a><V>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#807-812' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a new <code>FutureGuard</code> which will resolve into a a <code>OrderGuard</code>.</p>
- </div><h4 id='method.write' class="method"><span id='write.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.write' class='fnname'>write</a>(self) -> <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a><V, <a class="struct" href="../../ocl/struct.WriteGuard.html" title="struct ocl::WriteGuard">WriteGuard</a><V>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#815-820' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a new <code>FutureGuard</code> which will resolve into a a <code>OrderGuard</code>.</p>
- </div><h4 id='method.as_ptr' class="method"><span id='as_ptr.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub 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">*const V</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#825-827' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a reference to the inner value.</p>
- </div><h4 id='method.as_mut_ptr' class="method"><span id='as_mut_ptr.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.as_mut_ptr' class='fnname'>as_mut_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut V</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#832-834' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a mutable reference to the inner value.</p>
- </div></div>
- <h2 id='implementations' class='small-section-header'>
- Trait Implementations<a href='#implementations' class='anchor'></a>
- </h2>
- <div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <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/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#792' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#792' title='goto source code'>[src]</a></td></tr></tbody></table></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-From%3CQrwLock%3CV%3E%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<V> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../qutex/qrw_lock/struct.QrwLock.html" title="struct qutex::qrw_lock::QrwLock">QrwLock</a><V>> for <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V></code><a href='#impl-From%3CQrwLock%3CV%3E%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#843-847' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(q: <a class="struct" href="../../qutex/qrw_lock/struct.QrwLock.html" title="struct qutex::qrw_lock::QrwLock">QrwLock</a><V>) -> <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#844-846' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
- </div></div><h3 id='impl-From%3CV%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<V> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><V> for <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V></code><a href='#impl-From%3CV%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#849-853' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(vec: V) -> <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#850-852' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
- </div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<V> <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/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#855-862' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><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/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#857-861' title='goto source code'>[src]</a></td></tr></tbody></table></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'><table class='table-display'><tbody><tr><td><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: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span></td><td><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#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></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%3COrderLock%3CInner%3CT%3E%3E%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T: <a class="trait" href="../../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a><T>>> for <a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a><T></code><a href='#impl-From%3COrderLock%3CInner%3CT%3E%3E%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#372-376' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from-2' class="method"><span id='from.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(order_lock: <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a><T>>) -> <a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a><T></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_sink.rs.html#373-375' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
- </div></div><h3 id='impl-From%3COrderLock%3CInner%3CT%3E%3E%3E-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T: <a class="trait" href="../../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><<a class="struct" href="../../ocl/async/struct.BufferStreamInner.html" title="struct ocl::async::BufferStreamInner">Inner</a><T>>> for <a class="struct" href="../../ocl/async/struct.BufferStream.html" title="struct ocl::async::BufferStream">BufferStream</a><T></code><a href='#impl-From%3COrderLock%3CInner%3CT%3E%3E%3E-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_stream.rs.html#384-388' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from-3' class="method"><span id='from.v-3' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(order_lock: <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><<a class="struct" href="../../ocl/async/struct.BufferStreamInner.html" title="struct ocl::async::BufferStreamInner">Inner</a><T>>) -> <a class="struct" href="../../ocl/async/struct.BufferStream.html" title="struct ocl::async::BufferStream">BufferStream</a><T></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/async/buffer_stream.rs.html#385-387' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
- </div></div></div>
- <h2 id='synthetic-implementations' class='small-section-header'>
- Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
- </h2>
- <div id='synthetic-implementations-list'>
- <h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<V> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V> <span class="where fmt-newline">where<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<V> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a><V> <span class="where fmt-newline">where<br> V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "ocl";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|