struct.ScopedJoinHandle.html 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  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 `ScopedJoinHandle` struct in crate `crossbeam`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, ScopedJoinHandle">
  9. <title>crossbeam::ScopedJoinHandle - 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 struct">
  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'>Struct ScopedJoinHandle</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.join">join</a><a href="#method.thread">thread</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'>crossbeam</a></p><script>window.sidebarCurrent = {name: 'ScopedJoinHandle', ty: 'struct', 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'>Struct <a href='index.html'>crossbeam</a>::<wbr><a class="struct" href=''>ScopedJoinHandle</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/scoped.rs.html#40-44' title='goto source code'>[src]</a></span></h1>
  50. <pre class='rust struct'>pub struct ScopedJoinHandle&lt;T&gt; { /* fields omitted */ }</pre><div class='docblock'><p>A handle to a scoped thread</p>
  51. </div>
  52. <h2 id='methods' class='small-section-header'>
  53. Methods<a href='#methods' class='anchor'></a>
  54. </h2>
  55. <h3 id='impl' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="struct" href="../crossbeam/struct.ScopedJoinHandle.html" title="struct crossbeam::ScopedJoinHandle">ScopedJoinHandle</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/crossbeam/scoped.rs.html#297-308' title='goto source code'>[src]</a></span></h3>
  56. <div class='impl-items'><h4 id='method.join' class="method"><span id='join.v' class='invisible'><code>pub fn <a href='#method.join' class='fnname'>join</a>(self) -&gt; T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam/scoped.rs.html#299-302' title='goto source code'>[src]</a></span></h4>
  57. <div class='docblock'><p>Join the scoped thread, returning the result it produced.</p>
  58. </div><h4 id='method.thread' class="method"><span id='thread.v' class='invisible'><code>pub fn <a href='#method.thread' class='fnname'>thread</a>(&amp;self) -&gt; &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/std/thread/struct.Thread.html" title="struct std::thread::Thread">Thread</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam/scoped.rs.html#305-307' title='goto source code'>[src]</a></span></h4>
  59. <div class='docblock'><p>Get the underlying thread handle.</p>
  60. </div></div>
  61. <h2 id='implementations' class='small-section-header'>
  62. Trait Implementations<a href='#implementations' class='anchor'></a>
  63. </h2>
  64. <h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl&lt;T&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="../crossbeam/struct.ScopedJoinHandle.html" title="struct crossbeam::ScopedJoinHandle">ScopedJoinHandle</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/crossbeam/scoped.rs.html#74-78' title='goto source code'>[src]</a></span></h3>
  65. <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, 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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam/scoped.rs.html#75-77' title='goto source code'>[src]</a></span></h4>
  66. <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>
  67. </div></div></section>
  68. <section id='search' class="content hidden"></section>
  69. <section class="footer"></section>
  70. <aside id="help" class="hidden">
  71. <div>
  72. <h1 class="hidden">Help</h1>
  73. <div class="shortcuts">
  74. <h2>Keyboard Shortcuts</h2>
  75. <dl>
  76. <dt><kbd>?</kbd></dt>
  77. <dd>Show this help dialog</dd>
  78. <dt><kbd>S</kbd></dt>
  79. <dd>Focus the search field</dd>
  80. <dt><kbd>↑</kbd></dt>
  81. <dd>Move up in search results</dd>
  82. <dt><kbd>↓</kbd></dt>
  83. <dd>Move down in search results</dd>
  84. <dt><kbd>↹</kbd></dt>
  85. <dd>Switch tab</dd>
  86. <dt><kbd>&#9166;</kbd></dt>
  87. <dd>Go to active search result</dd>
  88. <dt><kbd>+</kbd></dt>
  89. <dd>Expand all sections</dd>
  90. <dt><kbd>-</kbd></dt>
  91. <dd>Collapse all sections</dd>
  92. </dl>
  93. </div>
  94. <div class="infos">
  95. <h2>Search Tricks</h2>
  96. <p>
  97. Prefix searches with a type followed by a colon (e.g.
  98. <code>fn:</code>) to restrict the search to a given type.
  99. </p>
  100. <p>
  101. Accepted types are: <code>fn</code>, <code>mod</code>,
  102. <code>struct</code>, <code>enum</code>,
  103. <code>trait</code>, <code>type</code>, <code>macro</code>,
  104. and <code>const</code>.
  105. </p>
  106. <p>
  107. Search functions by type signature (e.g.
  108. <code>vec -> usize</code> or <code>* -> vec</code>)
  109. </p>
  110. </div>
  111. </div>
  112. </aside>
  113. <script>
  114. window.rootPath = "../";
  115. window.currentCrate = "crossbeam";
  116. </script>
  117. <script src="../main.js"></script>
  118. <script defer src="../search-index.js"></script>
  119. </body>
  120. </html>