diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..47bdfe3 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +# These are supported funding model platforms + +github: [just-do-halee] diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..e61487b --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,85 @@ +name: CI + +on: + pull_request: + push: + branches: [main, master] + workflow_dispatch: + +env: + RUSTFLAGS: "-C debuginfo=0 -D warnings" + CARGO_TERM_COLOR: always + CARGO_INCREMENTAL: 0 + +jobs: + tests: + name: Tests + runs-on: ${{ matrix.os }} + continue-on-error: ${{ matrix.toolchain == 'nightly' || matrix.toolchain == 'beta' }} + strategy: + fail-fast: false + matrix: + os: [macos-latest, windows-latest, ubuntu-latest] + toolchain: [stable] + include: + - os: macos-latest + MACOS: true + - os: windows-latest + - os: ubuntu-latest + env: + RUST_BACKTRACE: full + RUSTV: ${{ matrix.toolchain }} + steps: + - uses: actions/checkout@v2 + + - name: Install Linux deps alsa and udev + run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev + if: runner.os == 'linux' + + - name: install ${{ matrix.toolchain }} toolchain + id: install_toolchain + uses: actions-rs/toolchain@v1 + with: + toolchain: ${{ matrix.toolchain }} + profile: minimal + # Don't use a 'components:' entry--we don't need them with beta/nightly, plus nightly often doesn't have them + override: true + + - name: Fetch cargo registry cache + uses: actions/cache@v3 + continue-on-error: false + with: + path: | + ~/.cargo/bin/ + ~/.cargo/registry/index/ + ~/.cargo/registry/cache/ + ~/.cargo/git/db/ + target/ + Cargo.lock + key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }} + if: runner.os != 'windows' + + - name: Fetch cargo registry cache (windows) + uses: actions/cache@v3 + continue-on-error: false + with: + path: | + C:\Rust\.cargo\bin + C:\Rust\.cargo\registry\index + C:\Rust\.cargo\registry\cache + C:\Rust\.cargo\git\db + target + Cargo.lock + key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }} + if: runner.os == 'windows' + + - name: rustfmt & clippy + run: | + rustup component add clippy rustfmt + cargo clippy --workspace + cargo fmt --all -- --check + if: matrix.toolchain == 'stable' && matrix.os == 'ubuntu-latest' + + - run: cargo test --workspace --all-targets --all-features + env: + MACOS: ${{ matrix.MACOS }} # Used by some tests diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4c790d0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/target +/Cargo.lock +.DS_Store diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e69de29 diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..590399d --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,29 @@ +[package] +name = "wag" +authors = ["just-do-halee "] +version = "0.1.0" +edition = "2021" +categories = ["asynchronous", "concurrency", "synchronization", "rust-patterns"] +keywords = ["sync", "async", "wait", "waitgroup", "wake"] +description = "Go like sync.WaitGroup implementation in Rust. (sync/async)" +homepage = "https://github.com/just-do-halee/wag" +repository = "https://github.com/just-do-halee/wag.git" +documentation = "https://docs.rs/wag" +license = "MIT OR Apache-2.0" +readme = "README.md" + +exclude = [".gitignore", ".github/"] + +[[example]] +name = "sync" +path = "examples/sync/sync.rs" +dev-dependencies = ["rand"] + +[[example]] +name = "async" +path = "examples/async/async.rs" +dev-dependencies = ["tokio", "rand"] + +[dev-dependencies] +rand = "0.8.5" +tokio = { version = "1.22.0", features = ["full"] } diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..2ef5184 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright 2022 Hwakyeom Kim(=just-do-halee) + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..0199329 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,26 @@ +Copyright 2022 Hwakyeom Kim(=just-do-halee) + +Permission is hereby granted, free of charge, +to any person obtaining a copy of this software +and associated documentation files (the "Software"), +to deal in the Software without restriction, +including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, +and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", +WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE +AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, +DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..15c635d --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# **`WAG`** + +Go like sync.WaitGroup implementation in Rust. (sync/async) + +[![CI][ci-badge]][ci-url] +[![Crates.io][crates-badge]][crates-url] +[![Licensed][license-badge]][license-url] +[![Twitter][twitter-badge]][twitter-url] + +[ci-badge]: https://github.com/just-do-halee/wag/actions/workflows/ci.yml/badge.svg +[crates-badge]: https://img.shields.io/crates/v/wag.svg?labelColor=383636 +[license-badge]: https://img.shields.io/crates/l/wag?labelColor=383636 +[twitter-badge]: https://img.shields.io/twitter/follow/do_halee?style=flat&logo=twitter&color=4a4646&labelColor=333131&label=just-do-halee +[ci-url]: https://github.com/just-do-halee/wag/actions +[twitter-url]: https://twitter.com/do_halee +[crates-url]: https://crates.io/crates/wag +[license-url]: https://github.com/just-do-halee/wag + +| [Examples](./examples/) | [Docs](https://docs.rs/wag) | [Latest Note](./CHANGELOG.md) | + +```toml +wag = "0.1.0" +``` + +## **`How to use,`** + +```rust +use wag::WaitGroup; +``` + +```rust +let wg = WaitGroup::new(); + +wg.adds::<10>().for_each(|child| { + + thread::spawn(move || { + // ... + child.done(); + }); + +}); +wg.wait(); // or wg.async_wait().await; +``` + +```rust +let wg = WaitGroup::new(); + +for _ in 0..10 { + let w = wg.add(); + + thread::spawn(move || { + // ... + w.done(); + }); + +}); +wg.wait(); // or wg.async_wait().await; +``` diff --git a/examples/async/async.rs b/examples/async/async.rs new file mode 100644 index 0000000..859044a --- /dev/null +++ b/examples/async/async.rs @@ -0,0 +1,17 @@ +use rand::prelude::*; + +use wag::WaitGroup; +#[tokio::main] +async fn main() { + let wg = WaitGroup::new(); + + wg.adds::<10>().for_each(|child| { + tokio::spawn(async move { + let duration = rand::thread_rng().gen_range(0..500); + tokio::time::sleep(std::time::Duration::from_millis(duration)).await; + println!("async sleep:{duration}"); + child.done(); + }); + }); + wg.async_wait().await; +} diff --git a/examples/sync/sync.rs b/examples/sync/sync.rs new file mode 100644 index 0000000..4049ccc --- /dev/null +++ b/examples/sync/sync.rs @@ -0,0 +1,16 @@ +use rand::prelude::*; +use std::{thread, time::Duration}; + +use wag::WaitGroup; +fn main() { + let wg = WaitGroup::new(); + wg.adds::<10>().enumerate().for_each(|(i, child)| { + thread::spawn(move || { + let duration = rand::thread_rng().gen_range(0..500); + thread::sleep(Duration::from_millis(duration)); + println!("sleep:{duration}, {i}"); + child.done(); + }); + }); + wg.wait(); +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..040d17f --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,85 @@ +use std::sync::Arc; + +pub struct WaitChild(Arc<()>); +impl WaitChild { + pub fn done(self) {} +} + +#[derive(Default)] +pub struct WaitGroup(Arc<()>); + +impl WaitGroup { + pub fn new() -> Self { + Self::default() + } + pub fn add(&self) -> WaitChild { + WaitChild(self.0.clone()) + } + pub fn adds(&self) -> impl Iterator + '_ { + (0..N).map(|_| self.add()) + } + pub fn wait(self) { + use std::{thread::sleep, time::Duration}; + + while Arc::strong_count(&self.0) > 1 { + sleep(Duration::from_millis(1)); + } + } + pub async fn async_wait(self) { + WaitFuture(self.0).await + } +} + +// -------------- Async -------------- +use std::future::Future; +use std::pin::Pin; +use std::task::{Context, Poll}; + +struct WaitFuture(Arc<()>); +impl Future for WaitFuture { + type Output = (); + + fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll { + if Arc::strong_count(&self.0) > 1 { + cx.waker().wake_by_ref(); + Poll::Pending + } else { + Poll::Ready(()) + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use rand::prelude::*; + use std::{thread, time::Duration}; + + #[test] + fn it_works() { + let wg = WaitGroup::new(); + wg.adds::<10>().enumerate().for_each(|(i, child)| { + thread::spawn(move || { + let duration = rand::thread_rng().gen_range(0..500); + thread::sleep(Duration::from_millis(duration)); + println!("sleep:{duration}, {i}"); + child.done(); + }); + }); + wg.wait(); + } + + #[tokio::test] + async fn it_works_async() { + let wg = WaitGroup::new(); + wg.adds::<10>().enumerate().for_each(|(i, child)| { + tokio::spawn(async move { + let duration = rand::thread_rng().gen_range(0..500); + tokio::time::sleep(Duration::from_millis(duration)).await; + println!("async sleep:{duration}, {i}"); + child.done(); + }); + }); + wg.async_wait().await; + } +}