hyena 0.2.4

A simple async task pool
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
55
56
57
58
59
60
61
62
63
64
65

use std::{
    future::Future,
    pin::Pin,
    task::{Context, Poll},
};

use futures_lite::future;

/// A task that can be spawned onto a [`TaskPool`](crate::TaskPool).
///
/// **Note** Tasks are cancelled when dropped.
#[derive(Debug)]
#[must_use = "Tasks are cancelled when they are dropped"]
pub struct Task<T> {
    inner: async_executor::Task<T>,
}

impl<T> Task<T> {
    /// Creates a new task from the wrapped task.
    #[inline]
    pub fn new(inner: async_executor::Task<T>) -> Self {
        Self { inner }
    }

    /// Returns true if the task has completed.
    #[inline]
    pub fn is_finished(&self) -> bool {
        self.inner.is_finished()
    }

    /// Detaches the task, causing it to run in the background.
    #[inline]
    pub fn detach(self) {
        self.inner.detach();
    }

    /// Cancels the task and waits for it to cancel. As opposed to dropping it.
    #[inline]
    pub async fn cancel(self) {
        self.inner.cancel().await;
    }

    /// Cancels the task and waits for it to cancel.
    ///
    /// This is equivalent to blocking on [`Task::cancel`](Task::cancel).
    #[inline]
    pub fn cancel_blocking(self) {
        future::block_on(self.cancel());
    }

    /// Runs the task to completion.
    #[inline]
    pub fn block_on(self) -> T {
        future::block_on(self.inner)
    }
}

impl<T> Future for Task<T> {
    type Output = T;

    #[inline]
    fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        Pin::new(&mut self.inner).poll(cx)
    }
}