Add tokio specific AsyncWaitGroup

.github/workflows/ci.yml

@@ -88,6 +88,24 @@ jobs:
         run: rustup update stable --no-self-update && rustup default stable
       - name: Test
         run: cargo test --lib --no-default-features --features future 
+
+  tokio:
+    name: tokio
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Rust
+        # --no-self-update is necessary because the windows environment cannot self-update rustup.exe.
+        run: rustup update stable --no-self-update && rustup default stable
+      - name: Test
+        run: cargo test --lib --no-default-features --features tokio
+
   sync:
     name: sync
     strategy:
@@ -109,6 +127,7 @@ jobs:
     name: cargo tarpaulin
     runs-on: ubuntu-latest
     needs:
+      - tokio
       - future
       - sync
       - build

Cargo.toml

@@ -6,7 +6,7 @@ homepage = "https://github.com/al8n/wg"
 repository = "https://github.com/al8n/wg.git"
 documentation = "https://docs.rs/wg/"
 readme = "README.md"
-version = "0.6.2"
+version = "0.7.0"
 license = "MIT OR Apache-2.0"
 keywords = ["waitgroup", "async", "sync", "notify", "wake"]
 categories = ["asynchronous", "concurrency", "data-structures"]
@@ -20,16 +20,33 @@ parking_lot = ["dep:parking_lot"]
 
 future = ["event-listener", "event-listener-strategy", "pin-project-lite"]
 
+tokio = ["dep:tokio", "futures-core"]
+
 [dependencies]
 parking_lot = { version = "0.12", optional = true }
 triomphe = { version = "0.1", optional = true }
 event-listener = { version = "5", optional = true }
 event-listener-strategy = { version = "0.5", optional = true }
 pin-project-lite = { version = "0.2", optional = true }
 
+tokio = { version = "1", default-features = false, optional = true, features = ["sync", "rt"] }
+futures-core = { version = "0.3", optional = true }
+
 [dev-dependencies]
 tokio = { version = "1", features = ["full"] }
+async-std = { version = "1", features = ["attributes"] }
 
 [package.metadata.docs.rs]
 all-features = true
 rustdoc-args = ["--cfg", "docsrs"]
+
+[[test]]
+name = "tokio"
+path = "tests/tokio.rs"
+required-features = ["tokio"]
+
+[[test]]
+name = "future"
+path = "tests/future.rs"
+required-features = ["future"]
+

README.md

@@ -16,27 +16,41 @@ Golang like WaitGroup implementation for sync/async Rust.
 <img alt="license" src="https://img.shields.io/badge/License-Apache%202.0/MIT-blue.svg?style=for-the-badge&fontColor=white&logoColor=f5c076&logo=data:image/svg+xml;base64,PCFET0NUWVBFIHN2ZyBQVUJMSUMgIi0vL1czQy8vRFREIFNWRyAxLjEvL0VOIiAiaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkIj4KDTwhLS0gVXBsb2FkZWQgdG86IFNWRyBSZXBvLCB3d3cuc3ZncmVwby5jb20sIFRyYW5zZm9ybWVkIGJ5OiBTVkcgUmVwbyBNaXhlciBUb29scyAtLT4KPHN2ZyBmaWxsPSIjZmZmZmZmIiBoZWlnaHQ9IjgwMHB4IiB3aWR0aD0iODAwcHgiIHZlcnNpb249IjEuMSIgaWQ9IkNhcGFfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgdmlld0JveD0iMCAwIDI3Ni43MTUgMjc2LjcxNSIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSIgc3Ryb2tlPSIjZmZmZmZmIj4KDTxnIGlkPSJTVkdSZXBvX2JnQ2FycmllciIgc3Ryb2tlLXdpZHRoPSIwIi8+Cg08ZyBpZD0iU1ZHUmVwb190cmFjZXJDYXJyaWVyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiLz4KDTxnIGlkPSJTVkdSZXBvX2ljb25DYXJyaWVyIj4gPGc+IDxwYXRoIGQ9Ik0xMzguMzU3LDBDNjIuMDY2LDAsMCw2Mi4wNjYsMCwxMzguMzU3czYyLjA2NiwxMzguMzU3LDEzOC4zNTcsMTM4LjM1N3MxMzguMzU3LTYyLjA2NiwxMzguMzU3LTEzOC4zNTcgUzIxNC42NDgsMCwxMzguMzU3LDB6IE0xMzguMzU3LDI1OC43MTVDNzEuOTkyLDI1OC43MTUsMTgsMjA0LjcyMywxOCwxMzguMzU3UzcxLjk5MiwxOCwxMzguMzU3LDE4IHMxMjAuMzU3LDUzLjk5MiwxMjAuMzU3LDEyMC4zNTdTMjA0LjcyMywyNTguNzE1LDEzOC4zNTcsMjU4LjcxNXoiLz4gPHBhdGggZD0iTTE5NC43OTgsMTYwLjkwM2MtNC4xODgtMi42NzctOS43NTMtMS40NTQtMTIuNDMyLDIuNzMyYy04LjY5NCwxMy41OTMtMjMuNTAzLDIxLjcwOC0zOS42MTQsMjEuNzA4IGMtMjUuOTA4LDAtNDYuOTg1LTIxLjA3OC00Ni45ODUtNDYuOTg2czIxLjA3Ny00Ni45ODYsNDYuOTg1LTQ2Ljk4NmMxNS42MzMsMCwzMC4yLDcuNzQ3LDM4Ljk2OCwyMC43MjMgYzIuNzgyLDQuMTE3LDguMzc1LDUuMjAxLDEyLjQ5NiwyLjQxOGM0LjExOC0yLjc4Miw1LjIwMS04LjM3NywyLjQxOC0xMi40OTZjLTEyLjExOC0xNy45MzctMzIuMjYyLTI4LjY0NS01My44ODItMjguNjQ1IGMtMzUuODMzLDAtNjQuOTg1LDI5LjE1Mi02NC45ODUsNjQuOTg2czI5LjE1Miw2NC45ODYsNjQuOTg1LDY0Ljk4NmMyMi4yODEsMCw0Mi43NTktMTEuMjE4LDU0Ljc3OC0zMC4wMDkgQzIwMC4yMDgsMTY5LjE0NywxOTguOTg1LDE2My41ODIsMTk0Ljc5OCwxNjAuOTAzeiIvPiA8L2c+IDwvZz4KDTwvc3ZnPg==" height="22">
 </div>
 
-## Installation
+## Introduction
 
-By default, blocking version `WaitGroup` is enabled, if you want to use non-blocking `AsyncWaitGroup`, you need to
-enbale `future` feature in your `Cargo.toml`.
+By default, blocking version `WaitGroup` is enabled.
+
+If you are using `tokio`, you need to enable `tokio` feature in your `Cargo.toml` and use `wg::tokio::AsyncWaitGroup`.
+
+If you are using other async runtime, you need to
+enbale `future` feature in your `Cargo.toml` and use `wg::future::AsyncWaitGroup`.
 
 ### Sync
 
 ```toml
 [dependencies]
-wg = "0.6"
+wg = "0.7"
 ```
 
-### Async
+### `tokio`
+
+An async implementation for `tokio` runtime.
 
 ```toml
 [dependencies]
-wg = { version: "0.6", features = ["future"] }
+wg = { version: "0.7", features = ["tokio"] }
 ```
 
+### `future`
 
-## Example
+A more generic async implementation.
+
+```toml
+[dependencies]
+wg = { version: "0.7", features = ["future"] }
+```
+
+## Instruction
 
 ### Sync
 
@@ -69,10 +83,10 @@ fn main() {
 }
 ```
 
-### Async
+### `tokio`
 
 ```rust
-use wg::AsyncWaitGroup;
+use wg::tokio::AsyncWaitGroup;
 use std::sync::Arc;
 use std::sync::atomic::{AtomicUsize, Ordering};
 use tokio::{spawn, time::{sleep, Duration}};
@@ -100,9 +114,42 @@ async fn main() {
 }
 ```
 
+### `async-io`
+
+```rust
+use wg::future::AsyncWaitGroup;
+use std::sync::Arc;
+use std::sync::atomic::{AtomicUsize, Ordering};
+use std::time::Duration;
+use async_std::task::{spawn, block_on, sleep};
+
+fn main() {
+    block_on(async {
+        let wg = AsyncWaitGroup::new();
+        let ctr = Arc::new(AtomicUsize::new(0));
+
+        for _ in 0..5 {
+            let ctrx = ctr.clone();
+            let t_wg = wg.add(1);
+            spawn(async move {
+                // mock some time consuming task
+                sleep(Duration::from_millis(50)).await;
+                ctrx.fetch_add(1, Ordering::Relaxed);
+
+                // mock task is finished
+                t_wg.done();
+            });
+        }
+
+        wg.wait().await;
+        assert_eq!(ctr.load(Ordering::Relaxed), 5);
+    });
+}
+```
+
 ## Acknowledgements
 
-- Inspired by Golang sync.WaitGroup, [ibraheemdev's `AwaitGroup`] and [`crossbeam_utils::WaitGroup`]. 
+- Inspired by Golang sync.WaitGroup and [`crossbeam_utils::WaitGroup`].
 
 ## License
 

examples/future.rs

@@ -0,0 +1,30 @@
+use std::sync::atomic::{AtomicUsize, Ordering};
+use std::sync::Arc;
+use tokio::{
+    spawn,
+    time::{sleep, Duration},
+};
+use wg::future::AsyncWaitGroup;
+
+fn main() {
+    async_std::task::block_on(async {
+        let wg = AsyncWaitGroup::new();
+        let ctr = Arc::new(AtomicUsize::new(0));
+
+        for _ in 0..5 {
+            let ctrx = ctr.clone();
+            let t_wg = wg.add(1);
+            spawn(async move {
+                // mock some time consuming task
+                sleep(Duration::from_millis(50)).await;
+                ctrx.fetch_add(1, Ordering::Relaxed);
+
+                // mock task is finished
+                t_wg.done();
+            });
+        }
+
+        wg.wait().await;
+        assert_eq!(ctr.load(Ordering::Relaxed), 5);
+    });
+}

examples/axync.rs → examples/tokio.rs

@@ -4,9 +4,9 @@ use tokio::{
     spawn,
     time::{sleep, Duration},
 };
-use wg::AsyncWaitGroup;
+use wg::tokio::AsyncWaitGroup;
 
-#[tokio::main(flavor = "multi_thread", worker_threads = 10)]
+#[tokio::main]
 async fn main() {
     let wg = AsyncWaitGroup::new();
     let ctr = Arc::new(AtomicUsize::new(0));