path: root/futures/src/executor.rs

//! Choose your preferred executor to power a runtime.
mod null;

#[cfg(all(not(target_arch = "wasm32"), feature = "thread-pool"))]
mod thread_pool;

#[cfg(all(not(target_arch = "wasm32"), feature = "tokio"))]
mod tokio;

#[cfg(all(not(target_arch = "wasm32"), feature = "tokio_old"))]
mod tokio_old;

#[cfg(all(not(target_arch = "wasm32"), feature = "async-std"))]
mod async_std;

#[cfg(target_arch = "wasm32")]
mod wasm_bindgen;

pub use null::Null;

#[cfg(all(not(target_arch = "wasm32"), feature = "thread-pool"))]
pub use thread_pool::ThreadPool;

#[cfg(all(not(target_arch = "wasm32"), feature = "tokio"))]
pub use self::tokio::Tokio;

#[cfg(all(not(target_arch = "wasm32"), feature = "tokio_old"))]
pub use self::tokio_old::TokioOld;

#[cfg(all(not(target_arch = "wasm32"), feature = "async-std"))]
pub use self::async_std::AsyncStd;

#[cfg(target_arch = "wasm32")]
pub use wasm_bindgen::WasmBindgen;

use futures::Future;

/// A type that can run futures.
pub trait Executor: Sized {
    /// Creates a new [`Executor`].
    ///
    /// [`Executor`]: trait.Executor.html
    fn new() -> Result<Self, futures::io::Error>
    where
        Self: Sized;

    /// Spawns a future in the [`Executor`].
    ///
    /// [`Executor`]: trait.Executor.html
    #[cfg(not(target_arch = "wasm32"))]
    fn spawn(&self, future: impl Future<Output = ()> + Send + 'static);

    /// Spawns a local future in the [`Executor`].
    ///
    /// [`Executor`]: trait.Executor.html
    #[cfg(target_arch = "wasm32")]
    fn spawn(&self, future: impl Future<Output = ()> + 'static);

    /// Runs the given closure inside the [`Executor`].
    ///
    /// Some executors, like `tokio`, require some global state to be in place
    /// before creating futures. This method can be leveraged to set up this
    /// global state, call a function, restore the state, and obtain the result
    /// of the call.
    ///
    /// [`Executor`]: trait.Executor.html
    fn enter<R>(&self, f: impl FnOnce() -> R) -> R {
        f()
    }
}