#future #tokio #task #prevent #shield #wrapping #aborted

tokio-shield

Prevent futures from being aborted by wrapping them in tasks

2 releases

0.1.1 Sep 20, 2023
0.1.0 May 25, 2023

#1633 in Asynchronous

Download history 9/week @ 2024-05-27 10/week @ 2024-06-03 15/week @ 2024-06-10 11/week @ 2024-06-17 14/week @ 2024-06-24 30/week @ 2024-07-01 10/week @ 2024-07-08 19/week @ 2024-07-15 15/week @ 2024-07-22 36/week @ 2024-07-29 15/week @ 2024-08-05 23/week @ 2024-08-12 7/week @ 2024-08-19 34/week @ 2024-08-26 15/week @ 2024-09-02 50/week @ 2024-09-09

109 downloads per month
Used in poem-ext

MIT license

7KB
71 lines

check test codecov Version dependency status

tokio-shield

Prevent futures in Rust from being aborted by wrapping them in tasks.

Example

use std::time::Duration;
use tokio::{sync::oneshot, time::sleep};
use tokio_shield::Shield;

#[tokio::main]
async fn main() {
    let (tx, mut rx) = oneshot::channel();

    // Create and shield a future that waits for 10ms and then returns a value
    // via a oneshot channel.
    let future = async {
        sleep(Duration::from_millis(10)).await;
        tx.send(42).unwrap();
    }.shield();

    // Spawn a task to run this future, but cancel it after 5ms.
    let task = tokio::spawn(future);
    sleep(Duration::from_millis(5)).await;
    task.abort();
    sleep(Duration::from_millis(5)).await;

    // After 10ms the value can successfully be read from the oneshot channel,
    // because `shield` prevented our future from being canceled.
    assert_eq!(rx.try_recv().unwrap(), 42);
}

Dependencies

~2.6–8MB
~61K SLoC