Install

#if using tokio, choose one of the two lines belowcargo add async-dropper --features tokio,derive     # use tokio, with the derive approachcargo add async-dropper --features tokio,simple     # use tokio, with the simple approach#if using async-std, chose one of the two lines belowcargo add async-dropper --features async-std,derive # use async-std, with the derive approachcargo add async-dropper --features async-std,simple # use async-std, with the simple approach

[dependencies]#async-dropper = { version = "0.3", features = [ "tokio", "derive" ] }#async-dropper = { version = "0.3", features = [ "tokio", "simple" ] }#async-dropper = { version = "0.3", features = [ "async-std", "derive" ] }#async-dropper = { version = "0.3", features = [ "async-std", "simple" ] }

Other features

Quickstart

async_dropper::simple

use std::{    result::Result,    time::Duration,};use async_dropper_simple::{AsyncDrop,AsyncDropper};use async_trait::async_trait;// NOTE: this example is rooted in crates/async-dropper/// This object will be async-dropped (which must be wrapped in AsyncDropper)#[derive(Default)]structAsyncThing(String);#[async_trait]implAsyncDropforAsyncThing{asyncfnasync_drop(&mutself){eprintln!("async dropping [{}]!",self.0);        tokio::time::sleep(Duration::from_secs(2)).await;eprintln!("dropped [{}]!",self.0);}}#[tokio::main]asyncfnmain() ->Result<(),Box<dyn std::error::Error>>{{let _example_obj =AsyncDropper::new(AsyncThing(String::from("test")));eprintln!("here comes the (async) drop");// drop will be triggered here, and it will take *however long it takes*// you could also call `drop(_example_obj)`}Ok(())}

cargo run --example simple-tokio --features=tokio

Don't like theDefault requirement?

async_dropper::derive

use std::{    result::Result,    time::Duration,};use async_dropper::derive::AsyncDrop;use async_trait::async_trait;/// This object will be async-dropped////// Objects that are dropped *must* implement [Default] and [PartialEq]/// (so make members optional, hide them behind Rc/Arc as necessary)#[derive(Debug,Default,PartialEq,Eq,AsyncDrop)]structAsyncThing(String);/// Implementation of [AsyncDrop] that specifies the actual behavior#[async_trait]implAsyncDropforAsyncThing{// simulated work during async_dropasyncfnasync_drop(&mutself) ->Result<(),AsyncDropError>{eprintln!("async dropping [{}]!",self.0);        tokio::time::sleep(Duration::from_secs(2)).await;eprintln!("dropped [{}]!",self.0);Ok(())}fndrop_timeout(&self) ->Duration{Duration::from_secs(5)// extended from default 3 seconds, as an example}// NOTE: the method below is automatically derived for you, but you can override it// make sure that the object is equal to T::default() by the end, otherwise it will panic!// fn reset(&mut self) {//     self.0 = String::default();// }// NOTE: below was not implemented since we want the default of DropFailAction::Continue// fn drop_fail_action(&self) -> DropFailAction;}#[tokio::main]asyncfnmain() ->Result<(),Box<dyn std::error::Error>>{{let _example_obj =AsyncThing(String::from("test"));eprintln!("here comes the (async) drop");// drop will be triggered here// you could also call `drop(_example_obj)`}Ok(())}

cargo run --example derive-tokio --features=tokio

Supported environments

FAQ

Why doesasync-dropper assume that I'm usingeitherasync-std ortokio?

Why do I have to choose betweensimple andderive features?

What doesasync_dropper::derive cost?

Development

just setup build

just test

just

Releasing

PUBLISH_CRATE=yes PKG=<crate name> just release <version>

PUBLISH_CRATE=yes PKG=async-dropper-simple just release patch

Contributing