RONCC
/
HPC-Tools-for-Quantum-Computing


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
							<!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="../../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 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&lt;QrwLock&lt;V&gt;&gt;</a><a href="#impl-From%3CV%3E">From&lt;V&gt;</a><a href="#impl-Clone">Clone</a><a href="#impl-From%3COrderLock%3CInner%3CT%3E%3E%3E">From&lt;OrderLock&lt;Inner&lt;T&gt;&gt;&gt;</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">
            </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'>&#x2212;</span>]
                   </a>
               </span><a class='srclink' href='../../src/ocl/async/order_lock.rs.html#793-795' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct OrderLock&lt;V&gt; { /* fields omitted */ }</pre><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'><code>impl&lt;V&gt; <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a>&lt;V&gt;</code><a href='#impl' class='anchor'></a></span><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></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(data: V) -&gt; <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a>&lt;V&gt;</code></span><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></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'><code>pub fn <a href='#method.read' class='fnname'>read</a>(self) -&gt; <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a>&lt;V, <a class="struct" href="../../ocl/struct.ReadGuard.html" title="struct ocl::ReadGuard">ReadGuard</a>&lt;V&gt;&gt;</code></span><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></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'><code>pub fn <a href='#method.write' class='fnname'>write</a>(self) -&gt; <a class="struct" href="../../ocl/async/struct.FutureGuard.html" title="struct ocl::async::FutureGuard">FutureGuard</a>&lt;V, <a class="struct" href="../../ocl/struct.WriteGuard.html" title="struct ocl::WriteGuard">WriteGuard</a>&lt;V&gt;&gt;</code></span><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></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'><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">*const V</a></code></span><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></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'><code>pub fn <a href='#method.as_mut_ptr' class='fnname'>as_mut_ptr</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut V</a></code></span><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></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>
        <h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl&lt;V:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>&gt; <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>&lt;V&gt;</code><a href='#impl-Debug' class='anchor'></a></span><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></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/async/order_lock.rs.html#792' 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-From%3CQrwLock%3CV%3E%3E' class='impl'><span class='in-band'><code>impl&lt;V&gt; <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="../../qutex/qrw_lock/struct.QrwLock.html" title="struct qutex::qrw_lock::QrwLock">QrwLock</a>&lt;V&gt;&gt; for <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a>&lt;V&gt;</code><a href='#impl-From%3CQrwLock%3CV%3E%3E' class='anchor'></a></span><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></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>(q: <a class="struct" href="../../qutex/qrw_lock/struct.QrwLock.html" title="struct qutex::qrw_lock::QrwLock">QrwLock</a>&lt;V&gt;) -&gt; <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a>&lt;V&gt;</code></span><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></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 id='impl-From%3CV%3E' class='impl'><span class='in-band'><code>impl&lt;V&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;V&gt; for <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a>&lt;V&gt;</code><a href='#impl-From%3CV%3E' class='anchor'></a></span><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></h3>
<div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(vec: V) -&gt; <a class="struct" href="../../ocl/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a>&lt;V&gt;</code></span><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></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl&lt;V&gt; <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>&lt;V&gt;</code><a href='#impl-Clone' class='anchor'></a></span><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></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/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a>&lt;V&gt;</code></span><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></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%3COrderLock%3CInner%3CT%3E%3E%3E' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <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/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a>&lt;<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a>&lt;T&gt;&gt;&gt; for <a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a>&lt;T&gt;</code><a href='#impl-From%3COrderLock%3CInner%3CT%3E%3E%3E' class='anchor'></a></span><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></h3>
<div class='impl-items'><h4 id='method.from-2' class="method"><span id='from.v-2' class='invisible'><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>&lt;<a class="struct" href="../../ocl/async/struct.BufferSinkInner.html" title="struct ocl::async::BufferSinkInner">Inner</a>&lt;T&gt;&gt;) -&gt; <a class="struct" href="../../ocl/async/struct.BufferSink.html" title="struct ocl::async::BufferSink">BufferSink</a>&lt;T&gt;</code></span><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></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'><code>impl&lt;T:&nbsp;<a class="trait" href="../../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt; <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/async/struct.OrderLock.html" title="struct ocl::async::OrderLock">OrderLock</a>&lt;<a class="struct" href="../../ocl/async/struct.BufferStreamInner.html" title="struct ocl::async::BufferStreamInner">Inner</a>&lt;T&gt;&gt;&gt; for <a class="struct" href="../../ocl/async/struct.BufferStream.html" title="struct ocl::async::BufferStream">BufferStream</a>&lt;T&gt;</code><a href='#impl-From%3COrderLock%3CInner%3CT%3E%3E%3E-1' class='anchor'></a></span><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></h3>
<div class='impl-items'><h4 id='method.from-3' class="method"><span id='from.v-3' class='invisible'><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>&lt;<a class="struct" href="../../ocl/async/struct.BufferStreamInner.html" title="struct ocl::async::BufferStreamInner">Inner</a>&lt;T&gt;&gt;) -&gt; <a class="struct" href="../../ocl/async/struct.BufferStream.html" title="struct ocl::async::BufferStream">BufferStream</a>&lt;T&gt;</code></span><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></span></h4>
<div class='docblock'><p>Performs the conversion.</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><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>