├── .github └── workflows │ └── rust.yml ├── .gitignore ├── .travis.build.sh ├── .travis.yml ├── Cargo.toml ├── LICENSE ├── README.md └── src └── lib.rs /.github/workflows/rust.yml: -------------------------------------------------------------------------------- 1 | name: Rust 2 | 3 | on: 4 | push: 5 | pull_request: 6 | 7 | env: 8 | CARGO_TERM_COLOR: always 9 | 10 | jobs: 11 | build: 12 | 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - uses: actions/checkout@v2 17 | - name: Build 18 | run: cargo build --verbose 19 | - name: fmt 20 | run: cargo fmt --verbose 21 | - name: Run tests 22 | run: cargo test --verbose 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | .idea 3 | -------------------------------------------------------------------------------- /.travis.build.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -e 3 | set -x 4 | 5 | if rustup component add clippy; 6 | then 7 | cargo clippy --all ; 8 | else 9 | echo 'Skipping clippy'; 10 | fi 11 | 12 | cargo build --release 13 | cargo test 14 | 15 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: rust 2 | rust: 3 | - stable 4 | sudo: false 5 | cache: cargo 6 | 7 | before_script: 8 | - rustup component add rustfmt 9 | script: 10 | - cargo fmt --all -- --check 11 | - bash ./.travis.build.sh 12 | 13 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "waitgroup" 3 | version = "0.1.2" 4 | authors = ["laizy "] 5 | edition = "2018" 6 | license = "Apache-2.0" 7 | homepage = "https://github.com/laizy/waitgroup-rs" 8 | repository = "https://github.com/laizy/waitgroup-rs" 9 | description = "Async waitgroup for a collection of task to finish" 10 | documentation = "https://docs.rs/waitgroup" 11 | keywords = ["waitgroup", "notify", "wake", "futures", "async"] 12 | categories = ["asynchronous", "concurrency"] 13 | readme = "README.md" 14 | 15 | [dependencies] 16 | atomic-waker = "1.0" 17 | 18 | [dev-dependencies] 19 | async-std = {version = "1.5.0", features = ["attributes"]} 20 | 21 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # waitgroup 2 | 3 | A WaitGroup waits for a collection of task to finish. 4 | 5 | ## Examples 6 | 7 | ```rust 8 | use waitgroup::WaitGroup; 9 | use async_std::task; 10 | async { 11 | let wg = WaitGroup::new(); 12 | for _ in 0..100 { 13 | // 1. basic usage 14 | let w = wg.worker(); 15 | task::spawn(async move { 16 | // do work... 17 | drop(w); // drop w means task finished, or just use `let _worker = w;` 18 | }); 19 | // 2. waiting nested tasks using `Worker::clone`. 20 | let w = wg.worker(); 21 | task::spawn(async move { 22 | let worker = w; 23 | // do work... 24 | let sub_task = worker.clone(); 25 | task::spawn(async move { 26 | let _sub_task = sub_task; 27 | // do work... 28 | }); 29 | }); 30 | // 3. waiting blocking tasks 31 | let blocking_worker = wg.worker(); 32 | std::thread::spawn(move || { 33 | let _blocking_worker = blocking_worker; 34 | // do blocking work... 35 | }); 36 | } 37 | 38 | wg.wait().await; 39 | } 40 | ``` 41 | 42 | 43 | # License 44 | 45 | This project is licensed under Apache License, Version 2.0 ([LICENSE](LICENSE) ). 46 | 47 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | //! A WaitGroup waits for a collection of task to finish. 2 | //! 3 | //! ## Examples 4 | //! ```rust 5 | //! use waitgroup::WaitGroup; 6 | //! use async_std::task; 7 | //! # task::block_on( 8 | //! async { 9 | //! let wg = WaitGroup::new(); 10 | //! for _ in 0..100 { 11 | //! // 1. basic usage 12 | //! let w = wg.worker(); 13 | //! task::spawn(async move { 14 | //! // do work... 15 | //! drop(w); // drop w means task finished, or just use `let _worker = w;` 16 | //! }); 17 | //! // 2. waiting nested tasks using `Worker::clone`. 18 | //! let w = wg.worker(); 19 | //! task::spawn(async move { 20 | //! let worker = w; 21 | //! // do work... 22 | //! let sub_task = worker.clone(); 23 | //! task::spawn(async move { 24 | //! let _sub_task = sub_task; 25 | //! // do work... 26 | //! }); 27 | //! }); 28 | //! // 3. waiting blocking tasks 29 | //! let blocking_worker = wg.worker(); 30 | //! std::thread::spawn(move || { 31 | //! let _blocking_worker = blocking_worker; 32 | //! // do blocking work... 33 | //! }); 34 | //! } 35 | //! 36 | //! wg.wait().await; 37 | //! } 38 | //! # ); 39 | //! ``` 40 | 41 | use atomic_waker::AtomicWaker; 42 | use std::future::Future; 43 | use std::pin::Pin; 44 | use std::sync::{Arc, Weak}; 45 | use std::task::{Context, Poll}; 46 | 47 | pub struct WaitGroup { 48 | inner: Arc, 49 | } 50 | 51 | #[derive(Clone)] 52 | pub struct Worker(Arc); 53 | 54 | pub struct WaitGroupFuture { 55 | inner: Weak, 56 | } 57 | 58 | impl WaitGroupFuture { 59 | /// Gets the number of active workers. 60 | pub fn workers(&self) -> usize { 61 | Weak::strong_count(&self.inner) 62 | } 63 | } 64 | 65 | struct Inner { 66 | waker: AtomicWaker, 67 | } 68 | 69 | impl Drop for Inner { 70 | fn drop(&mut self) { 71 | self.waker.wake(); 72 | } 73 | } 74 | 75 | impl WaitGroup { 76 | pub fn new() -> Self { 77 | Self { 78 | inner: Arc::new(Inner { 79 | waker: AtomicWaker::new(), 80 | }), 81 | } 82 | } 83 | 84 | pub fn worker(&self) -> Worker { 85 | Worker(self.inner.clone()) 86 | } 87 | 88 | /// Gets the number of active workers. 89 | pub fn workers(&self) -> usize { 90 | Arc::strong_count(&self.inner) - 1 91 | } 92 | 93 | pub fn wait(self) -> WaitGroupFuture { 94 | WaitGroupFuture { 95 | inner: Arc::downgrade(&self.inner), 96 | } 97 | } 98 | } 99 | 100 | impl Default for WaitGroup { 101 | fn default() -> Self { 102 | Self::new() 103 | } 104 | } 105 | 106 | /* 107 | IntoFuture tracking issue: https://github.com/rust-lang/rust/issues/67644 108 | impl IntoFuture for WaitGroup { 109 | type Output = (); 110 | type Future = WaitGroupFuture; 111 | 112 | fn into_future(self) -> Self::Future { 113 | WaitGroupFuture { inner: Arc::downgrade(&self.inner) } 114 | } 115 | } 116 | */ 117 | 118 | impl Future for WaitGroupFuture { 119 | type Output = (); 120 | 121 | fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll { 122 | match self.inner.upgrade() { 123 | Some(inner) => { 124 | inner.waker.register(cx.waker()); 125 | Poll::Pending 126 | } 127 | None => Poll::Ready(()), 128 | } 129 | } 130 | } 131 | 132 | #[cfg(test)] 133 | mod test { 134 | use super::*; 135 | use async_std::task; 136 | 137 | #[async_std::test] 138 | async fn smoke() { 139 | let wg = WaitGroup::new(); 140 | 141 | for _ in 0..100 { 142 | let w = wg.worker(); 143 | task::spawn(async move { 144 | drop(w); 145 | }); 146 | } 147 | 148 | wg.wait().await; 149 | } 150 | } 151 | --------------------------------------------------------------------------------