| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/futures-executor-0.3.28/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../futures_executor/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../futures_executor/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Built-in executors and related tools. |
| //! |
| //! All asynchronous computation occurs within an executor, which is |
| //! capable of spawning futures as tasks. This module provides several |
| //! built-in executors, as well as tools for building your own. |
| //! |
| //! All items are only available when the `std` feature of this |
| //! library is activated, and it is activated by default. |
| //! |
| //! # Using a thread pool (M:N task scheduling) |
| //! |
| //! Most of the time tasks should be executed on a [thread pool](ThreadPool). |
| //! A small set of worker threads can handle a very large set of spawned tasks |
| //! (which are much lighter weight than threads). Tasks spawned onto the pool |
| //! with the [`spawn_ok`](ThreadPool::spawn_ok) function will run ambiently on |
| //! the created threads. |
| //! |
| //! # Spawning additional tasks |
| //! |
| //! Tasks can be spawned onto a spawner by calling its [`spawn_obj`] method |
| //! directly. In the case of `!Send` futures, [`spawn_local_obj`] can be used |
| //! instead. |
| //! |
| //! # Single-threaded execution |
| //! |
| //! In addition to thread pools, it's possible to run a task (and the tasks |
| //! it spawns) entirely within a single thread via the [`LocalPool`] executor. |
| //! Aside from cutting down on synchronization costs, this executor also makes |
| //! it possible to spawn non-`Send` tasks, via [`spawn_local_obj`]. The |
| //! [`LocalPool`] is best suited for running I/O-bound tasks that do relatively |
| //! little work between I/O operations. |
| //! |
| //! There is also a convenience function [`block_on`] for simply running a |
| //! future to completion on the current thread. |
| //! |
| //! [`spawn_obj`]: https://docs.rs/futures/0.3/futures/task/trait.Spawn.html#tymethod.spawn_obj |
| //! [`spawn_local_obj`]: https://docs.rs/futures/0.3/futures/task/trait.LocalSpawn.html#tymethod.spawn_local_obj |
| |
| </span><span class="attribute">#![cfg_attr(not(feature = <span class="string">"std"</span>), no_std)] |
| #![warn( |
| missing_debug_implementations, |
| missing_docs, |
| rust_2018_idioms, |
| single_use_lifetimes, |
| unreachable_pub |
| )] |
| #![doc(test( |
| no_crate_inject, |
| attr( |
| deny(warnings, rust_2018_idioms, single_use_lifetimes), |
| allow(dead_code, unused_assignments, unused_variables) |
| ) |
| ))] |
| #![cfg_attr(docsrs, feature(doc_cfg))] |
| |
| #[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">mod </span>local_pool; |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::local_pool::{block_on, block_on_stream, BlockingStream, LocalPool, LocalSpawner}; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"thread-pool"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"thread-pool"</span>)))] |
| #[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">mod </span>thread_pool; |
| <span class="attribute">#[cfg(feature = <span class="string">"thread-pool"</span>)] |
| #[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">mod </span>unpark_mutex; |
| <span class="attribute">#[cfg(feature = <span class="string">"thread-pool"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"thread-pool"</span>)))] |
| #[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::thread_pool::{ThreadPool, ThreadPoolBuilder}; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">mod </span>enter; |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::enter::{enter, Enter, EnterError}; |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures_executor" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |