#tokio #service #error #background #generic #utility #run-time

cancellable

A Rust library providing a generic cancellable utility

5 unstable releases

0.3.1 Aug 6, 2023
0.3.0 Jul 28, 2023
0.2.0 Jul 27, 2023
0.1.1 Jul 25, 2023
0.1.0 Jul 25, 2023

#531 in Asynchronous

43 downloads per month
Used in reception

MIT license

19KB
296 lines

Cancellable

ci-master Crates.io docs.rs Crates.io

A Rust library providing a generic cancellable utility.

The goal of this library is to provide a unified way of defining background services that are managed by the tokio runtime.

Examples

For working examples see examples/ folder.

use std::{error::Error, net::SocketAddr};

use cancellable::{async_trait, Cancellable, CancellationResult};
use tokio::net::{TcpListener, TcpStream};

struct Listener {
    tcp_listener: TcpListener,
}

impl Listener {
    async fn new() -> Result<Self, Box<dyn Error>> {
        let tcp_listener = TcpListener::bind("127.0.0.1:5000").await?;

        Ok(Self { tcp_listener })
    }
}

#[async_trait]
impl Cancellable for Listener {
    type Result = (TcpStream, SocketAddr);
    type Handle = ();
    type Error = std::io::Error;

    async fn new_handle(&mut self) -> Self::Handle {}

    async fn run(&mut self) -> Result<CancellationResult<Self::Result>, Self::Error> {
        let (addr, stream) = self.tcp_listener.accept().await?;

        Ok(CancellationResult::item((addr, stream)))
    }
}

License

See LICENSE.txt file.

Dependencies

~2.8–4.5MB
~73K SLoC