al8n / wg

Golang like WaitGroup implementation for sync/async Rust, support no_std environment.

wg

Golang like WaitGroup implementation for sync/async Rust, support no_std environment.

Introduction

By default, blocking version WaitGroup is enabled.

If you are using other async runtime, you need to enbale future feature in your Cargo.toml and use wg::AsyncWaitGroup.

Installation

• std

  [dependencies]
  wg = "0.9"

• future

  [dependencies]
  wg = { version = "0.9", features = ["future"] }

• no_std

  [dependencies]
  wg = { version = "0.9", default_features = false, features = ["alloc"] }

• no_std & future

  [dependencies]
  wg = { version = "0.9", default_features = false, features = ["alloc", "future"] }

Examples

Sync

use wg::WaitGroup;
use std::sync::Arc;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::time::Duration;
use std::thread::{spawn, sleep};

fn main() {
    let wg = WaitGroup::new();
    let ctr = Arc::new(AtomicUsize::new(0));

    for _ in 0..5 {
        let ctrx = ctr.clone();
        let t_wg = wg.add(1);
        spawn(move || {
            // mock some time consuming task
            sleep(Duration::from_millis(50));
            ctrx.fetch_add(1, Ordering::Relaxed);

            // mock task is finished
            t_wg.done();
        });
    }

    wg.wait();
    assert_eq!(ctr.load(Ordering::Relaxed), 5);
}

Async

use wg::AsyncWaitGroup;
use std::sync::Arc;
use std::sync::atomic::{AtomicUsize, Ordering};
use tokio::{spawn, time::{sleep, Duration}};

#[tokio::main]
async fn main() {
    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 and crossbeam_utils::WaitGroup.

License

^{Licensed under either of Apache License, Version 2.0 or MIT license at your option.} _{Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.}

wg's Issues

How to use AsyncWaitGroup?

This is just copied from the code file/documentation for reference:

/// use wg::AsyncWaitGroup;
/// use std::sync::Arc;
/// use std::sync::atomic::{AtomicUsize, Ordering};
/// use tokio::{spawn, time::{sleep, Duration}};

How do you import AsyncWaitGroup? Neither of these work?

10 | use wg::AsyncWaitGroup;
   |     ^^^^^^^^^^^^^^^^^^ no `AsyncWaitGroup` in the root

use wg::async::AsyncWaitGroup;
   |         ^^^^^ could not find `r#async` in `wg`