#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

#1735 in Asynchronous

Download history 18/week @ 2024-07-20 36/week @ 2024-07-27 14/week @ 2024-08-03 22/week @ 2024-08-10 10/week @ 2024-08-17 19/week @ 2024-08-24 26/week @ 2024-08-31 47/week @ 2024-09-07 13/week @ 2024-09-14 25/week @ 2024-09-21 24/week @ 2024-09-28 8/week @ 2024-10-05 22/week @ 2024-10-12 17/week @ 2024-10-19 42/week @ 2024-10-26 66/week @ 2024-11-02

147 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
~62K SLoC