1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
use tokio_02::runtime::Handle; use tokio_02::task::JoinHandle; use tokio_executor_01::{self as executor_01, Executor as Executor01}; use futures_01::future::{self as future_01, Future as Future01}; use futures_util::{compat::Future01CompatExt, future::FutureExt}; use std::future::Future; /// Executes futures on the runtime /// /// All futures spawned using this executor will be submitted to the associated /// Runtime's executor. This executor is usually a thread pool. /// /// For more details, see the [module level](index.html) documentation. #[derive(Debug, Clone)] #[cfg_attr(docsrs, doc(cfg(feature = "rt-full")))] pub struct TaskExecutor { pub(super) inner: super::compat::CompatSpawner<Handle>, } impl TaskExecutor { /// Spawn a `futures` 0.1 future onto the Tokio runtime. /// /// This spawns the given future onto the runtime's executor, usually a /// thread pool. The thread pool is then responsible for polling the future /// until it completes. /// /// See [module level][mod] documentation for more details. /// /// [mod]: index.html /// /// # Examples /// /// ``` /// use tokio_compat::runtime::Runtime; /// # fn dox() { /// // Create the runtime /// let rt = Runtime::new().unwrap(); /// let executor = rt.executor(); /// /// // Spawn a `futures` 0.1 future onto the runtime /// executor.spawn(futures_01::future::lazy(|| { /// println!("now running on a worker thread"); /// Ok(()) /// })); /// # } /// ``` pub fn spawn<F>(&self, future: F) where F: Future01<Item = (), Error = ()> + Send + 'static, { let future = Box::pin(future.compat().map(|_| ())); self.spawn_std(future) } /// Spawn a `std::future` future onto the Tokio runtime. /// /// This spawns the given future onto the runtime's executor, usually a /// thread pool. The thread pool is then responsible for polling the future /// until it completes. /// /// See [module level][mod] documentation for more details. /// /// [mod]: index.html /// /// # Examples /// /// ``` /// use tokio_compat::runtime::Runtime; /// /// # fn dox() { /// // Create the runtime /// let rt = Runtime::new().unwrap(); /// let executor = rt.executor(); /// /// // Spawn a `std::future` future onto the runtime /// executor.spawn_std(async { /// println!("now running on a worker thread"); /// }); /// # } /// ``` pub fn spawn_std<F>(&self, future: F) where F: Future<Output = ()> + Send + 'static, { let idle = self.inner.idle.reserve(); let _ = self.inner.inner.spawn(idle.with(future)); } /// Spawn a `futures` 0.1 future onto the Tokio runtime, returning a /// `JoinHandle` that can be used to await its result. /// /// This spawns the given future onto the runtime's executor, usually a /// thread pool. The thread pool is then responsible for polling the future /// until it completes. /// /// **Note** that futures spawned in this manner do not "count" towards /// keeping the runtime active for [`shutdown_on_idle`], since they are paired /// with a `JoinHandle` for awaiting their completion. See [here] for /// details on shutting down the compatibility runtime. /// /// [mod]: index.html /// [`shutdown_on_idle`]: struct.Runtime.html#method.shutdown_on_idle /// [here]: index.html#shutting-down /// /// # Examples /// /// ``` /// use tokio_compat::runtime::Runtime; /// # fn dox() { /// // Create the runtime /// let rt = Runtime::new().unwrap(); /// let executor = rt.executor(); /// /// // Spawn a `futures` 0.1 future onto the runtime /// executor.spawn(futures_01::future::lazy(|| { /// println!("now running on a worker thread"); /// Ok(()) /// })); /// # } /// ``` pub fn spawn_handle<F>(&self, future: F) -> JoinHandle<Result<F::Item, F::Error>> where F: Future01 + Send + 'static, F::Item: Send + 'static, F::Error: Send + 'static, { let future = Box::pin(future.compat()); self.spawn_handle_std(future) } /// Spawn a `std::future` future onto the Tokio runtime, returning a /// `JoinHandle` that can be used to await its result. /// /// This spawns the given future onto the runtime's executor, usually a /// thread pool. The thread pool is then responsible for polling the future /// until it completes. /// /// See [module level][mod] documentation for more details. /// /// **Note** that futures spawned in this manner do not "count" towards /// keeping the runtime active for [`shutdown_on_idle`], since they are paired /// with a `JoinHandle` for awaiting their completion. See [here] for /// details on shutting down the compatibility runtime. /// /// [mod]: index.html /// [`shutdown_on_idle`]: struct.Runtime.html#method.shutdown_on_idle /// [here]: index.html#shutting-down /// /// # Examples /// /// ``` /// use tokio_compat::runtime::Runtime; /// /// # fn dox() { /// // Create the runtime /// let rt = Runtime::new().unwrap(); /// let executor = rt.executor(); /// /// // Spawn a `std::future` future onto the runtime /// executor.spawn_std(async { /// println!("now running on a worker thread"); /// }); /// # } /// ``` /// /// # Panics /// /// This function panics if the spawn fails. Failure occurs if the executor /// is currently at capacity and is unable to spawn a new future. pub fn spawn_handle_std<F>(&self, future: F) -> JoinHandle<F::Output> where F: Future + Send + 'static, F::Output: Send + 'static, { self.inner.inner.spawn(future) } } impl<T> future_01::Executor<T> for TaskExecutor where T: Future01<Item = (), Error = ()> + Send + 'static, { fn execute(&self, future: T) -> Result<(), future_01::ExecuteError<T>> { self.spawn(future); Ok(()) } } impl Executor01 for TaskExecutor { fn spawn( &mut self, future: Box<dyn Future01<Item = (), Error = ()> + Send>, ) -> Result<(), executor_01::SpawnError> { Executor01::spawn(&mut self.inner, future) } } impl<T> executor_01::TypedExecutor<T> for TaskExecutor where T: Future01<Item = (), Error = ()> + Send + 'static, { fn spawn(&mut self, future: T) -> Result<(), executor_01::SpawnError> { executor_01::TypedExecutor::spawn(&mut self.inner, future) } }