corsa_runtime 0.7.0

Small executor, task primitives, and broadcast channels for corsa
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
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

use crate::block_on;
use std::{future::Future, thread};

/// Join handle returned by [`spawn`].
///
/// Unlike async task handles from full runtimes, this always represents a
/// dedicated OS thread.
pub struct JoinHandle<T> {
    inner: thread::JoinHandle<T>,
}

/// Spawns a future onto a dedicated worker thread.
///
/// The spawned thread immediately runs [`crate::block_on`] on the provided
/// future and exits when the future resolves.
///
/// # Examples
///
/// ```
/// use corsa_runtime::spawn;
///
/// let handle = spawn(async { String::from("tsgo") });
/// assert_eq!(handle.join().unwrap(), "tsgo");
/// ```
pub fn spawn<F>(future: F) -> JoinHandle<F::Output>
where
    F: Future + Send + 'static,
    F::Output: Send + 'static,
{
    JoinHandle {
        inner: thread::spawn(move || block_on(future)),
    }
}

impl<T> JoinHandle<T> {
    /// Waits for the worker thread to finish and returns its output.
    ///
    /// Panics from the worker thread are reported through the standard
    /// [`thread::Result`] error payload.
    pub fn join(self) -> thread::Result<T> {
        self.inner.join()
    }
}

#[cfg(test)]
mod tests {
    use super::spawn;

    #[test]
    fn spawn_runs_future_on_worker_thread() {
        let handle = spawn(async { 5_u32 + 7 });
        assert_eq!(handle.join().unwrap(), 12);
    }
}