صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
RONCC
/
HPC-Tools-for-Quantum-Computing
دنبال کردن 1
ستاره دار 0
انشعاب 0
پرونده‌ها مشکلات 0 درخواست واکشی 0 ویکی
درخت: e971e022d2
شاخه‌ها تگ‌ها
HPC-Tools-fo...
/
doc
/
futures
/
sync
/
struct.BiLock.html

struct.BiLock.html 14 KB
تاريخچه خام

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758 
  1. <!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="../../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">&#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><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'>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"><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'>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><div class="docblock type-decl"><pre class='rust struct'>pub struct BiLock&lt;T&gt; { /* fields omitted */ }</pre></div><div class='docblock'><p>A type of futures-powered synchronization primitive which is a mutex between
    2. 

  2. two possible owners.</p>
    3. 

  3. <p>This primitive is not as generic as a full-blown mutex but is sufficient for
    4. 

  4. many use cases where there are only two possible owners of a resource. The
    5. 

  5. implementation of <code>BiLock</code> can be more optimized for just the two possible
    6. 

  6. owners.</p>
    7. 

  7. <p>Note that it's possible to use this lock through a poll-style interface with
    8. 

  8. the <code>poll_lock</code> method but you can also use it as a future with the <code>lock</code>
    9. 

  9. method that consumes a <code>BiLock</code> and returns a future that will resolve when
    10. 

  10. it's locked.</p>
    11. 

  11. <p>A <code>BiLock</code> is typically used for &quot;split&quot; operations where data which serves
    12. 

  12. two purposes wants to be split into two to be worked with separately. For
    13. 

  13. example a TCP stream could be both a reader and a writer or a framing layer
    14. 

  14. could be both a stream and a sink for messages. A <code>BiLock</code> enables splitting
    15. 

  15. these two and then using each independently in a futures-powered fashion.</p>
    16. 

  16. </div>
    17. 

  17.                     <h2 id='methods' class='small-section-header'>
    18. 

  18.                       Methods<a href='#methods' class='anchor'></a>
    19. 

  19.                     </h2>
    20. 

  20.                 <h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><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></td><td><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></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>(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></td><td><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></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new <code>BiLock</code> protecting the provided data.</p>
    21. 

  21. <p>Two handles to the lock are returned, and these are the only two handles
    22. 

  22. that will ever be available to the lock. These can then be sent to separate
    23. 

  23. tasks to be managed there.</p>
    24. 

  24. </div><h4 id='method.poll_lock' class="method"><span id='poll_lock.v' class='invisible'><table class='table-display'><tbody><tr><td><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></td><td><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></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempt to acquire this lock, returning <code>NotReady</code> if it can't be
    25. 

  25. acquired.</p>
    26. 

  26. <p>This function will acquire the lock in a nonblocking fashion, returning
    27. 

  27. immediately if the lock is already held. If the lock is successfully
    28. 

  28. acquired then <code>Async::Ready</code> is returned with a value that represents
    29. 

  29. the locked value (and can be used to access the protected data). The
    30. 

  30. lock is unlocked when the returned <code>BiLockGuard</code> is dropped.</p>
    31. 

  31. <p>If the lock is already held then this function will return
    32. 

  32. <code>Async::NotReady</code>. In this case the current task will also be scheduled
    33. 

  33. to receive a notification when the lock would otherwise become
    34. 

  34. available.</p>
    35. 

  35. <h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
    36. 

  36. <p>This function will panic if called outside the context of a future's
    37. 

  37. task.</p>
    38. 

  38. </div><h4 id='method.lock' class="method"><span id='lock.v' class='invisible'><table class='table-display'><tbody><tr><td><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></td><td><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></td></tr></tbody></table></span></h4><div class='docblock'><p>Perform a &quot;blocking lock&quot; of this lock, consuming this lock handle and
    39. 

  39. returning a future to the acquired lock.</p>
    40. 

  40. <p>This function consumes the <code>BiLock&lt;T&gt;</code> and returns a sentinel future,
    41. 

  41. <code>BiLockAcquire&lt;T&gt;</code>. The returned future will resolve to
    42. 

  42. <code>BiLockAcquired&lt;T&gt;</code> which represents a locked lock similarly to
    43. 

  43. <code>BiLockGuard&lt;T&gt;</code>.</p>
    44. 

  44. <p>Note that the returned future will never resolve to an error.</p>
    45. 

  45. </div><h4 id='method.reunite' class="method"><span id='reunite.v' class='invisible'><table class='table-display'><tbody><tr><td><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></td><td><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></td></tr></tbody></table></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
    46. 

  46. recover the original value. Succeeds only if the two <code>BiLock&lt;T&gt;</code>s
    47. 

  47. originated from the same call to <code>BiLock::new</code>.</p>
    48. 

  48. </div></div>
    49. 

  49.                 <h2 id='implementations' class='small-section-header'>
    50. 

  50.                   Trait Implementations<a href='#implementations' class='anchor'></a>
    51. 

  51.                 </h2>
    52. 

  52.                 <div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><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></td><td><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></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>(&amp;self, f: &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></td><td><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></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>
    53. 

  53. </div></div></div>
    54. 

  54.                 <h2 id='synthetic-implementations' class='small-section-header'>
    55. 

  55.                   Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
    56. 

  56.                 </h2>
    57. 

  57.                 <div id='synthetic-implementations-list'>
    58. 

  58.             <h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; <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="../../futures/sync/struct.BiLock.html" title="struct futures::sync::BiLock">BiLock</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,&nbsp;</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&lt;T&gt; <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="../../futures/sync/struct.BiLock.html" title="struct futures::sync::BiLock">BiLock</a>&lt;T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,&nbsp;</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>&#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><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 = "futures";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
    59.