RONCC
/
HPC-Tools-for-Quantum-Computing


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186
							<!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 `BiLock` struct in crate `futures`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, BiLock">

    <title>futures::sync::BiLock - 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 BiLock</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.poll_lock">poll_lock</a><a href="#method.lock">lock</a><a href="#method.reunite">reunite</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='../index.html'>futures</a>::<wbr><a href='index.html'>sync</a></p><script>window.sidebarCurrent = {name: 'BiLock', 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'>futures</a>::<wbr><a href='index.html'>sync</a>::<wbr><a class="struct" href=''>BiLock</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/futures/sync/bilock.rs.html#34-36' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct BiLock&lt;T&gt; { /* fields omitted */ }</pre><div class='docblock'><p>A type of futures-powered synchronization primitive which is a mutex between
two possible owners.</p>
<p>This primitive is not as generic as a full-blown mutex but is sufficient for
many use cases where there are only two possible owners of a resource. The
implementation of <code>BiLock</code> can be more optimized for just the two possible
owners.</p>
<p>Note that it's possible to use this lock through a poll-style interface with
the <code>poll_lock</code> method but you can also use it as a future with the <code>lock</code>
method that consumes a <code>BiLock</code> and returns a future that will resolve when
it's locked.</p>
<p>A <code>BiLock</code> is typically used for &quot;split&quot; operations where data which serves
two purposes wants to be split into two to be worked with separately. For
example a TCP stream could be both a reader and a writer or a framing layer
could be both a stream and a sink for messages. A <code>BiLock</code> enables splitting
these two and then using each independently in a futures-powered fashion.</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;T&gt; <a class="struct" href="../../futures/sync/struct.BiLock.html" title="struct futures::sync::BiLock">BiLock</a>&lt;T&gt;</code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/sync/bilock.rs.html#47-168' 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>(t: T) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../../futures/sync/struct.BiLock.html" title="struct futures::sync::BiLock">BiLock</a>&lt;T&gt;, <a class="struct" href="../../futures/sync/struct.BiLock.html" title="struct futures::sync::BiLock">BiLock</a>&lt;T&gt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/sync/bilock.rs.html#53-60' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Creates a new <code>BiLock</code> protecting the provided data.</p>
<p>Two handles to the lock are returned, and these are the only two handles
that will ever be available to the lock. These can then be sent to separate
tasks to be managed there.</p>
</div><h4 id='method.poll_lock' class="method"><span id='poll_lock.v' class='invisible'><code>pub fn <a href='#method.poll_lock' class='fnname'>poll_lock</a>(&amp;self) -&gt; <a class="enum" href="../../futures/enum.Async.html" title="enum futures::Async">Async</a>&lt;<a class="struct" href="../../futures/sync/struct.BiLockGuard.html" title="struct futures::sync::BiLockGuard">BiLockGuard</a>&lt;T&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/sync/bilock.rs.html#80-120' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Attempt to acquire this lock, returning <code>NotReady</code> if it can't be
acquired.</p>
<p>This function will acquire the lock in a nonblocking fashion, returning
immediately if the lock is already held. If the lock is successfully
acquired then <code>Async::Ready</code> is returned with a value that represents
the locked value (and can be used to access the protected data). The
lock is unlocked when the returned <code>BiLockGuard</code> is dropped.</p>
<p>If the lock is already held then this function will return
<code>Async::NotReady</code>. In this case the current task will also be scheduled
to receive a notification when the lock would otherwise become
available.</p>
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
<p>This function will panic if called outside the context of a future's
task.</p>
</div><h4 id='method.lock' class="method"><span id='lock.v' class='invisible'><code>pub fn <a href='#method.lock' class='fnname'>lock</a>(self) -&gt; <a class="struct" href="../../futures/sync/struct.BiLockAcquire.html" title="struct futures::sync::BiLockAcquire">BiLockAcquire</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/sync/bilock.rs.html#131-135' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Perform a &quot;blocking lock&quot; of this lock, consuming this lock handle and
returning a future to the acquired lock.</p>
<p>This function consumes the <code>BiLock&lt;T&gt;</code> and returns a sentinel future,
<code>BiLockAcquire&lt;T&gt;</code>. The returned future will resolve to
<code>BiLockAcquired&lt;T&gt;</code> which represents a locked lock similarly to
<code>BiLockGuard&lt;T&gt;</code>.</p>
<p>Note that the returned future will never resolve to an error.</p>
</div><h4 id='method.reunite' class="method"><span id='reunite.v' class='invisible'><code>pub fn <a href='#method.reunite' class='fnname'>reunite</a>(self, other: 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;T, ReuniteError&lt;T&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/sync/bilock.rs.html#140-150' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Attempts to put the two &quot;halves&quot; of a <code>BiLock&lt;T&gt;</code> back together and
recover the original value. Succeeds only if the two <code>BiLock&lt;T&gt;</code>s
originated from the same call to <code>BiLock::new</code>.</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;T:&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="../../futures/sync/struct.BiLock.html" title="struct futures::sync::BiLock">BiLock</a>&lt;T&gt;</code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/sync/bilock.rs.html#33' 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/futures/sync/bilock.rs.html#33' 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></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 = "futures";
    </script>
    <script src="../../main.js"></script>
    <script defer src="../../search-index.js"></script>
</body>
</html>