Home Verkennen Help
Inloggen
RONCC
/
HPC-Tools-for-Quantum-Computing
Volgen 1
Ster 0
Vork 0
Bestanden Kwesties 0 Pull-aanvragen 0 Wiki
Boom: e971e022d2
Aftakkingen Labels
HPC-Tools-fo...
/
doc
/
qutex
/
index.html

index.html 8.7 KB
Geschiedenis Ruwe

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495 
  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 `qutex` crate."><meta name="keywords" content="rust, rustlang, rust-lang, qutex"><title>qutex - 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 mod"><!--[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'>Crate qutex</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'qutex', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>qutex</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/qutex/lib.rs.html#1-17' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>A collection of locking data structures, both thread-safe and
    2. 

  2. single-thread-optimized, which use Rust futures instead of
    3. 

  3. thread-blocking.</p>
    4. 

  4. <p><a href="https://github.com/cogciprocate/qutex"><img src="https://img.shields.io/badge/github-qutex-blue.svg" alt="" /></a> <a href="https://crates.io/crates/qutex"><img src="http://meritbadge.herokuapp.com/qutex" alt="" /></a></p>
    5. 

  5. </div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
    6. 

  6. <table>
    7. 

  7.                        <tr class=' module-item'>
    8. 

  8.                            <td><a class="struct" href="struct.FutureGuard.html"
    9. 

  9.                                   title='struct qutex::FutureGuard'>FutureGuard</a></td>
    10. 

  10.                            <td class='docblock-short'>
    11. 

  11.                                 <p>A future which resolves to a <code>Guard</code>.</p>
    12. 

  12. 

  13.                            </td>
    14. 

  14.                        </tr>
    15. 

  15.                        <tr class=' module-item'>
    16. 

  16.                            <td><a class="struct" href="struct.FutureReadGuard.html"
    17. 

  17.                                   title='struct qutex::FutureReadGuard'>FutureReadGuard</a></td>
    18. 

  18.                            <td class='docblock-short'>
    19. 

  19.                                 <p>A future which resolves to a <code>ReadGuard</code>.</p>
    20. 

  20. 

  21.                            </td>
    22. 

  22.                        </tr>
    23. 

  23.                        <tr class=' module-item'>
    24. 

  24.                            <td><a class="struct" href="struct.FutureWriteGuard.html"
    25. 

  25.                                   title='struct qutex::FutureWriteGuard'>FutureWriteGuard</a></td>
    26. 

  26.                            <td class='docblock-short'>
    27. 

  27.                                 <p>A future which resolves to a <code>WriteGuard</code>.</p>
    28. 

  28. 

  29.                            </td>
    30. 

  30.                        </tr>
    31. 

  31.                        <tr class=' module-item'>
    32. 

  32.                            <td><a class="struct" href="struct.Guard.html"
    33. 

  33.                                   title='struct qutex::Guard'>Guard</a></td>
    34. 

  34.                            <td class='docblock-short'>
    35. 

  35.                                 <p>Allows access to the data contained within a lock just like a mutex guard.</p>
    36. 

  36. 

  37.                            </td>
    38. 

  38.                        </tr>
    39. 

  39.                        <tr class=' module-item'>
    40. 

  40.                            <td><a class="struct" href="struct.QrwLock.html"
    41. 

  41.                                   title='struct qutex::QrwLock'>QrwLock</a></td>
    42. 

  42.                            <td class='docblock-short'>
    43. 

  43.                                 <p>A queue-backed read/write data lock.</p>
    44. 

  44. 

  45.                            </td>
    46. 

  46.                        </tr>
    47. 

  47.                        <tr class=' module-item'>
    48. 

  48.                            <td><a class="struct" href="struct.QrwRequest.html"
    49. 

  49.                                   title='struct qutex::QrwRequest'>QrwRequest</a></td>
    50. 

  50.                            <td class='docblock-short'>
    51. 

  51.                                 <p>A request to lock the lock for either read or write access.</p>
    52. 

  52. 

  53.                            </td>
    54. 

  54.                        </tr>
    55. 

  55.                        <tr class=' module-item'>
    56. 

  56.                            <td><a class="struct" href="struct.Qutex.html"
    57. 

  57.                                   title='struct qutex::Qutex'>Qutex</a></td>
    58. 

  58.                            <td class='docblock-short'>
    59. 

  59.                                 <p>A lock-free-queue-backed exclusive data lock.</p>
    60. 

  60. 

  61.                            </td>
    62. 

  62.                        </tr>
    63. 

  63.                        <tr class=' module-item'>
    64. 

  64.                            <td><a class="struct" href="struct.ReadGuard.html"
    65. 

  65.                                   title='struct qutex::ReadGuard'>ReadGuard</a></td>
    66. 

  66.                            <td class='docblock-short'>
    67. 

  67.                                 <p>Allows read-only access to the data contained within a lock.</p>
    68. 

  68. 

  69.                            </td>
    70. 

  70.                        </tr>
    71. 

  71.                        <tr class=' module-item'>
    72. 

  72.                            <td><a class="struct" href="struct.Request.html"
    73. 

  73.                                   title='struct qutex::Request'>Request</a></td>
    74. 

  74.                            <td class='docblock-short'>
    75. 

  75.                                 <p>A request to lock the qutex for exclusive access.</p>
    76. 

  76. 

  77.                            </td>
    78. 

  78.                        </tr>
    79. 

  79.                        <tr class=' module-item'>
    80. 

  80.                            <td><a class="struct" href="struct.WriteGuard.html"
    81. 

  81.                                   title='struct qutex::WriteGuard'>WriteGuard</a></td>
    82. 

  82.                            <td class='docblock-short'>
    83. 

  83.                                 <p>Allows read or write access to the data contained within a lock.</p>
    84. 

  84. 

  85.                            </td>
    86. 

  86.                        </tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
    87. 

  87. <table>
    88. 

  88.                        <tr class=' module-item'>
    89. 

  89.                            <td><a class="enum" href="enum.RequestKind.html"
    90. 

  90.                                   title='enum qutex::RequestKind'>RequestKind</a></td>
    91. 

  91.                            <td class='docblock-short'>
    92. 

  92.                                 <p>Specifies whether a <code>QrwRequest</code> is a read or write request.</p>
    93. 

  93. 

  94.                            </td>
    95. 

  95.                        </tr></table></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 = "qutex";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
    96.