diath 0.5.1

diath is a light-weight library for communication between tokio async tasks
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

use std::future::Future;
use tokio::task::JoinHandle;

/// Represents the possible results of running an async task until timeout
pub enum TaskTimeoutResult<Result>
where Result: Send {
    Timeout,
    Completed(Result)
}

/// Executes an async task until timeout of provided duration.
/// Returns an ExecuteTaskResult::Completed(Result) If the task was executed until completion where Result is the return type of the task
/// Returns an ExecuteTaskResult::Timeout otherwise.
pub async fn execute_until_timeout<Task, Duration>(task: Task, duration: Duration) -> TaskTimeoutResult<Task::Output>
    where Task: Future,
          Task::Output: Send,
          Duration: Into<std::time::Duration>,
{
    let timeout = tokio::time::sleep(duration.into());
    tokio::select! {
        _ = timeout => {
            TaskTimeoutResult::Timeout
        },
        r = task => {
            TaskTimeoutResult::Completed(r)
        }
    }
}

/// Executes an async task until timeout of provided duration on a different task.
/// Returns an ExecuteTaskResult::Completed(Result) If the task was executed until completion where Result is the return type of the task
/// Returns an ExecuteTaskResult::Timeout otherwise.
pub async fn execute_task_until_timeout<Task, Duration>(task: Task, duration: Duration) -> JoinHandle<TaskTimeoutResult<Task::Output>>
    where Task: Future + Send + 'static,
          Task::Output: Send,
          Duration: Into<std::time::Duration>,
{
    let timeout = tokio::time::sleep(duration.into());
    let f = async {
        tokio::select! {
        _ = timeout => {
            TaskTimeoutResult::Timeout
        },
        r = task => {
            TaskTimeoutResult::Completed(r)
        }
    }
    };
    tokio::task::spawn(f)
}