fn.current.html 6.0 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 `current` fn in crate `futures`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, current">
  9. <title>futures::task::current - 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 fn">
  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'><a href='../index.html'>futures</a>::<wbr><a href='index.html'>task</a></p><script>window.sidebarCurrent = {name: 'current', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script>
  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'>Function <a href='../index.html'>futures</a>::<wbr><a href='index.html'>task</a>::<wbr><a class="fn" href=''>current</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/futures/task_impl/mod.rs.html#89-100' title='goto source code'>[src]</a></span></h1>
  50. <pre class='rust fn'>pub fn current() -&gt; <a class="struct" href="../../futures/task/struct.Task.html" title="struct futures::task::Task">Task</a></pre><div class='docblock'><p>Returns a handle to the current task to call <code>notify</code> at a later date.</p>
  51. <p>The returned handle implements the <code>Send</code> and <code>'static</code> bounds and may also
  52. be cheaply cloned. This is useful for squirreling away the handle into a
  53. location which is then later signaled that a future can make progress.</p>
  54. <p>Implementations of the <code>Future</code> trait typically use this function if they
  55. would otherwise perform a blocking operation. When something isn't ready
  56. yet, this <code>current</code> function is called to acquire a handle to the current
  57. task, and then the future arranges it such that when the blocking operation
  58. otherwise finishes (perhaps in the background) it will <code>notify</code> the
  59. returned handle.</p>
  60. <p>It's sometimes necessary to pass extra information to the task when
  61. unparking it, so that the task knows something about <em>why</em> it was woken.
  62. See the <code>FutureQueue</code> documentation for details on how to do this.</p>
  63. <h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
  64. <p>This function will panic if a task is not currently being executed. That
  65. is, this method can be dangerous to call outside of an implementation of
  66. <code>poll</code>.</p>
  67. </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 = "futures";
  116. </script>
  117. <script src="../../main.js"></script>
  118. <script defer src="../../search-index.js"></script>
  119. </body>
  120. </html>