index.html 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `sync` mod in crate `crossbeam`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, sync">
  9. <title>crossbeam::sync - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
  14. <script src="../../storage.js"></script>
  15. </head>
  16. <body class="rustdoc mod">
  17. <!--[if lte IE 8]>
  18. <div class="warning">
  19. This old browser is unsupported and will most likely display funky
  20. things.
  21. </div>
  22. <![endif]-->
  23. <nav class="sidebar">
  24. <div class="sidebar-menu">&#9776;</div>
  25. <p class='location'>Module sync</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li></ul></div><p class='location'><a href='../index.html'>crossbeam</a></p><script>window.sidebarCurrent = {name: 'sync', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div>
  26. </nav>
  27. <div class="theme-picker">
  28. <button id="theme-picker" aria-label="Pick another theme!">
  29. <img src="../../brush.svg" width="18" alt="Pick another theme!">
  30. </button>
  31. <div id="theme-choices"></div>
  32. </div>
  33. <script src="../../theme.js"></script>
  34. <nav class="sub">
  35. <form class="search-form js-only">
  36. <div class="search-container">
  37. <input class="search-input" name="search"
  38. autocomplete="off"
  39. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  40. type="search">
  41. </div>
  42. </form>
  43. </nav>
  44. <section id='main' class="content">
  45. <h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>crossbeam</a>::<wbr><a class="mod" href=''>sync</a></span><span class='out-of-band'><span id='render-detail'>
  46. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  47. [<span class='inner'>&#x2212;</span>]
  48. </a>
  49. </span><a class='srclink' href='../../src/crossbeam/sync/mod.rs.html#1-14' title='goto source code'>[src]</a></span></h1>
  50. <div class='docblock'><p>Synchronization primitives.</p>
  51. </div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
  52. <table>
  53. <tr class=' module-item'>
  54. <td><a class="mod" href="chase_lev/index.html"
  55. title='mod crossbeam::sync::chase_lev'>chase_lev</a></td>
  56. <td class='docblock-short'>
  57. <p>A lock-free concurrent work-stealing deque</p>
  58. </td>
  59. </tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
  60. <table>
  61. <tr class=' module-item'>
  62. <td><a class="struct" href="struct.ArcCell.html"
  63. title='struct crossbeam::sync::ArcCell'>ArcCell</a></td>
  64. <td class='docblock-short'>
  65. <p>A type providing atomic storage and retrieval of an <code>Arc&lt;T&gt;</code>.</p>
  66. </td>
  67. </tr>
  68. <tr class=' module-item'>
  69. <td><a class="struct" href="struct.AtomicOption.html"
  70. title='struct crossbeam::sync::AtomicOption'>AtomicOption</a></td>
  71. <td class='docblock-short'>
  72. </td>
  73. </tr>
  74. <tr class=' module-item'>
  75. <td><a class="struct" href="struct.MsQueue.html"
  76. title='struct crossbeam::sync::MsQueue'>MsQueue</a></td>
  77. <td class='docblock-short'>
  78. <p>A Michael-Scott lock-free queue, with support for blocking <code>pop</code>s.</p>
  79. </td>
  80. </tr>
  81. <tr class=' module-item'>
  82. <td><a class="struct" href="struct.SegQueue.html"
  83. title='struct crossbeam::sync::SegQueue'>SegQueue</a></td>
  84. <td class='docblock-short'>
  85. <p>A Michael-Scott queue that allocates &quot;segments&quot; (arrays of nodes)
  86. for efficiency.</p>
  87. </td>
  88. </tr>
  89. <tr class=' module-item'>
  90. <td><a class="struct" href="struct.TreiberStack.html"
  91. title='struct crossbeam::sync::TreiberStack'>TreiberStack</a></td>
  92. <td class='docblock-short'>
  93. <p>Treiber's lock-free stack.</p>
  94. </td>
  95. </tr></table></section>
  96. <section id='search' class="content hidden"></section>
  97. <section class="footer"></section>
  98. <aside id="help" class="hidden">
  99. <div>
  100. <h1 class="hidden">Help</h1>
  101. <div class="shortcuts">
  102. <h2>Keyboard Shortcuts</h2>
  103. <dl>
  104. <dt><kbd>?</kbd></dt>
  105. <dd>Show this help dialog</dd>
  106. <dt><kbd>S</kbd></dt>
  107. <dd>Focus the search field</dd>
  108. <dt><kbd>↑</kbd></dt>
  109. <dd>Move up in search results</dd>
  110. <dt><kbd>↓</kbd></dt>
  111. <dd>Move down in search results</dd>
  112. <dt><kbd>↹</kbd></dt>
  113. <dd>Switch tab</dd>
  114. <dt><kbd>&#9166;</kbd></dt>
  115. <dd>Go to active search result</dd>
  116. <dt><kbd>+</kbd></dt>
  117. <dd>Expand all sections</dd>
  118. <dt><kbd>-</kbd></dt>
  119. <dd>Collapse all sections</dd>
  120. </dl>
  121. </div>
  122. <div class="infos">
  123. <h2>Search Tricks</h2>
  124. <p>
  125. Prefix searches with a type followed by a colon (e.g.
  126. <code>fn:</code>) to restrict the search to a given type.
  127. </p>
  128. <p>
  129. Accepted types are: <code>fn</code>, <code>mod</code>,
  130. <code>struct</code>, <code>enum</code>,
  131. <code>trait</code>, <code>type</code>, <code>macro</code>,
  132. and <code>const</code>.
  133. </p>
  134. <p>
  135. Search functions by type signature (e.g.
  136. <code>vec -> usize</code> or <code>* -> vec</code>)
  137. </p>
  138. </div>
  139. </div>
  140. </aside>
  141. <script>
  142. window.rootPath = "../../";
  143. window.currentCrate = "crossbeam";
  144. </script>
  145. <script src="../../main.js"></script>
  146. <script defer src="../../search-index.js"></script>
  147. </body>
  148. </html>