byor 1.0.0

Bring your own runtime!
Documentation 
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

//! Executors for running tasks.

#[cfg(feature = "exec")]
mod multi_thread;
#[cfg(feature = "exec")]
pub use multi_thread::*;

#[cfg(feature = "local-exec")]
pub mod local;

/// A handle to a spawned task.
///
/// Dropping the handle will cancel the task. Awaiting it will wait for the task to complete.
pub trait Handle<T: 'static>: Future<Output = Self::Wrap<T>> {
    #[cfg_attr(not(feature = "tokio"), allow(rustdoc::broken_intra_doc_links))]
    /// A wrapper around the return type of a task.
    ///
    /// This is only used by tokio, whose [`JoinHandle`](tokio::task::JoinHandle) returns a
    /// [`Result`].
    type Wrap<U>;

    /// Drops the task _without_ canceling it.
    ///
    /// This is useful if you want a task to run in the background.
    fn detach(self);
}