Skip to content

Commit a5d9baf

Browse files
committed
asyncs to ease async runtime agnostic development
0 parents  commit a5d9baf

File tree

11 files changed

+675
-0
lines changed

11 files changed

+675
-0
lines changed

.github/workflows/ci.yml

+106
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
name: CI
2+
on:
3+
push:
4+
pull_request:
5+
6+
env:
7+
RUSTFLAGS: -Dwarnings
8+
RUST_BACKTRACE: 1
9+
10+
jobs:
11+
fmt:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v4
15+
- uses: Swatinem/rust-cache@v2
16+
- name: Install latest nightly
17+
uses: actions-rs/toolchain@v1
18+
with:
19+
toolchain: nightly
20+
override: true
21+
components: rustfmt
22+
- name: Check formatting
23+
run: cargo fmt --all -- --check
24+
25+
build:
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: actions/checkout@v4
29+
- uses: Swatinem/rust-cache@v2
30+
- name: Install rust stable
31+
uses: actions-rs/toolchain@v1
32+
with:
33+
toolchain: stable
34+
override: true
35+
- name: Build code
36+
run: cargo build --workspace --examples
37+
38+
test:
39+
needs: [build]
40+
runs-on: ubuntu-latest
41+
steps:
42+
- uses: actions/checkout@v4
43+
- uses: Swatinem/rust-cache@v2
44+
- name: Install rust stable
45+
uses: actions-rs/toolchain@v1
46+
with:
47+
toolchain: stable
48+
override: true
49+
- name: Test code
50+
run: cargo test --all-features -- --nocapture
51+
52+
coverage:
53+
if: github.event_name == 'pull_request' || (github.event_name == 'push' && github.ref_type == 'branch' && github.ref_name == 'master')
54+
needs: [test]
55+
runs-on: ubuntu-latest
56+
env:
57+
RUST_LOG: debug
58+
RUSTFLAGS: -Cinstrument-coverage
59+
steps:
60+
- uses: actions/checkout@v4
61+
- uses: Swatinem/rust-cache@v1
62+
- name: Install rust stable
63+
uses: actions-rs/toolchain@v1
64+
with:
65+
toolchain: stable
66+
override: true
67+
components: llvm-tools
68+
- run: cargo install grcov
69+
- run: cargo build --verbose
70+
- name: Run tests
71+
run: LLVM_PROFILE_FILE="asyncs-%p-%m.profraw" cargo test --all-features --verbose -- --nocapture
72+
- name: Generate coverage report
73+
run: grcov $(find . -name "asyncs-*.profraw" -print) --binary-path ./target/debug/ -s . -t lcov --branch --ignore-not-existing --ignore "/*" -o lcov.info
74+
- name: Upload to codecov.io
75+
uses: codecov/codecov-action@v4
76+
with:
77+
verbose: true
78+
79+
lint:
80+
needs: [build]
81+
runs-on: ubuntu-latest
82+
steps:
83+
- uses: actions/checkout@v4
84+
- uses: Swatinem/rust-cache@v2
85+
- name: Install rust stable
86+
uses: actions-rs/toolchain@v1
87+
with:
88+
toolchain: stable
89+
override: true
90+
components: clippy
91+
- name: Lint code
92+
run: cargo clippy --no-deps -- -D clippy::all
93+
94+
release:
95+
if: github.event_name == 'push' && github.ref_type == 'tag'
96+
needs: [build, test, lint]
97+
runs-on: ubuntu-latest
98+
steps:
99+
- uses: actions/checkout@v4
100+
- uses: Swatinem/rust-cache@v2
101+
- name: install cargo-workspaces to publish workspace
102+
run: cargo install cargo-workspaces
103+
- name: publish crate
104+
env:
105+
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
106+
run: cargo workspaces publish --from-git

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/target
2+
Cargo.lock

.rustfmt.toml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
edition = "2021"
2+
max_width = 120
3+
imports_granularity = "Module"
4+
imports_layout = "HorizontalVertical"
5+
newline_style = "Unix"
6+
normalize_comments = true
7+
normalize_doc_attributes = true
8+
brace_style = "PreferSameLine"
9+
use_small_heuristics = "Max"
10+
match_block_trailing_comma = true
11+
overflow_delimited_expr = true
12+
reorder_impl_items = true
13+
group_imports = "StdExternalCrate"

Cargo.toml

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
[workspace]
2+
resolver = "2"
3+
members = ["asyncs-test"]
4+
5+
[workspace.package]
6+
license = "Apache-2.0"
7+
version = "0.1.0"
8+
edition = "2021"
9+
homepage = "https://github.com/kezhuw/asyncs"
10+
repository = "https://github.com/kezhuw/asyncs"
11+
documentation = "https://docs.rs/asyncs"
12+
13+
[package]
14+
name = "asyncs"
15+
version.workspace = true
16+
edition.workspace = true
17+
homepage.workspace = true
18+
license.workspace = true
19+
repository.workspace = true
20+
documentation.workspace = true
21+
22+
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
23+
24+
[features]
25+
# For tests
26+
test = ["spawns-compat", "spawns/executor", "asyncs-test"]
27+
28+
# For binary crates
29+
tokio = ["spawns/tokio"]
30+
smol = ["spawns/smol"]
31+
async-global-executor = ["spawns/async-global-executor"]
32+
33+
# For doc inline of "spawns-core/compat"
34+
spawns-compat = ["spawns-core/compat"]
35+
36+
[dependencies]
37+
async-select = "0.1.1"
38+
asyncs-test = { version = "0.1.0", path = "./asyncs-test", optional = true }
39+
spawns = { version = "0.2.3", optional = true }
40+
spawns-core = "1.1.0"
41+
42+
[dev-dependencies]
43+
test-case = "3.3.1"
44+
45+
[package.metadata.docs.rs]
46+
all-features = true

LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
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.

Makefile

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
verify: check build test
2+
3+
check: check_fmt lint doc
4+
5+
fmt:
6+
cargo +nightly fmt --all
7+
8+
check_fmt:
9+
cargo +nightly fmt --all -- --check
10+
11+
lint:
12+
cargo clippy --all-features --no-deps -- -D clippy::all
13+
14+
build:
15+
cargo build-all-features
16+
17+
test:
18+
cargo test --all-features
19+
20+
doc:
21+
cargo doc --all-features

0 commit comments

Comments
 (0)