├── .gitignore ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md └── src └── lib.rs /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | Cargo.lock 3 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "async_fn_traits" 3 | version = "0.1.1" 4 | authors = ["Frank Steffahn "] 5 | license = "MIT OR Apache-2.0" 6 | description = """ 7 | Trait synonyms for “Fn[…]”-trait bounds returning futures 8 | """ 9 | repository = "https://github.com/steffahn/async_fn_traits" 10 | homepage = "https://github.com/steffahn/async_fn_traits" 11 | documentation = "https://docs.rs/async_fn_traits" 12 | keywords = ["async"] 13 | categories = ["no-std", "rust-patterns"] 14 | readme = "README.md" 15 | edition = "2018" 16 | 17 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 18 | 19 | [dependencies] 20 | paste = "1.0.6" 21 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 Frank Steffahn 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # async_fn_traits 2 | 3 | [![docs.rs]](https://docs.rs/async_fn_traits) 4 | [![crates.io]](https://crates.io/crates/async_fn_traits) 5 | [![github]](https://github.com/steffahn/async_fn_traits) 6 | [![MIT / Apache 2.0 licensed]](#License) 7 | [![unsafe forbidden]](https://github.com/rust-secure-code/safety-dance/) 8 | 9 | [github]: https://img.shields.io/badge/github-steffahn/async__fn__traits-yellowgreen.svg 10 | [crates.io]: https://img.shields.io/crates/v/async_fn_traits.svg 11 | [MIT / Apache 2.0 licensed]: https://img.shields.io/crates/l/async_fn_traits.svg 12 | [docs.rs]: https://docs.rs/async_fn_traits/badge.svg 13 | [unsafe forbidden]: https://img.shields.io/badge/unsafe-forbidden-success.svg 14 | 15 | Trait synonyms for `Fn[…]`-trait bounds returning futures. 16 | 17 | E.g. a 2-argument function `async fn foo(x: Bar, y: Baz) -> Qux` will implement 18 | [AsyncFn2](https://docs.rs/async_fn_traits/0.1/async_fn_traits/trait.AsyncFn2.html). 19 | 20 | ## License 21 | Licensed under either of 22 | 23 | * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) 24 | * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) 25 | 26 | at your option. 27 | 28 | Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in 29 | the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without 30 | any additional terms or conditions. 31 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | #![no_std] 2 | #![forbid(unsafe_code)] 3 | // reasonable clippy categories 4 | #![warn(clippy::pedantic, clippy::nursery, clippy::cargo)] 5 | // reasonable clippy::restriction lints 6 | #![warn( 7 | clippy::as_conversions, 8 | clippy::clone_on_ref_ptr, 9 | clippy::create_dir, 10 | clippy::dbg_macro, 11 | clippy::decimal_literal_representation, 12 | clippy::default_numeric_fallback, 13 | clippy::else_if_without_else, 14 | clippy::exhaustive_enums, 15 | clippy::exhaustive_structs, 16 | clippy::exit, 17 | clippy::expect_used, 18 | clippy::filetype_is_file, 19 | clippy::float_arithmetic, 20 | clippy::float_cmp_const, 21 | clippy::get_unwrap, 22 | clippy::if_then_some_else_none, 23 | clippy::indexing_slicing, 24 | clippy::integer_arithmetic, 25 | clippy::integer_division, 26 | clippy::let_underscore_must_use, 27 | clippy::lossy_float_literal, 28 | clippy::map_err_ignore, 29 | clippy::mem_forget, 30 | clippy::missing_docs_in_private_items, 31 | clippy::modulo_arithmetic, 32 | clippy::multiple_inherent_impl, 33 | clippy::panic, 34 | clippy::panic_in_result_fn, 35 | clippy::pattern_type_mismatch, 36 | clippy::print_stderr, 37 | clippy::print_stdout, 38 | clippy::rc_buffer, 39 | clippy::rest_pat_in_fully_bound_structs, 40 | clippy::str_to_string, 41 | clippy::string_add, 42 | clippy::string_to_string, 43 | clippy::todo, 44 | clippy::unimplemented, 45 | clippy::unnecessary_self_imports, 46 | clippy::unneeded_field_pattern, 47 | clippy::unreachable, 48 | clippy::unwrap_in_result, 49 | clippy::unwrap_used, 50 | clippy::use_debug, 51 | clippy::verbose_file_reads, 52 | clippy::wildcard_enum_match_arm 53 | )] 54 | // reasonable rustc lints 55 | #![warn( 56 | elided_lifetimes_in_paths, 57 | explicit_outlives_requirements, 58 | macro_use_extern_crate, 59 | meta_variable_misuse, 60 | missing_abi, 61 | missing_copy_implementations, 62 | missing_debug_implementations, 63 | missing_docs, 64 | non_ascii_idents, 65 | noop_method_call, 66 | semicolon_in_expressions_from_macros, 67 | single_use_lifetimes, 68 | trivial_casts, 69 | trivial_numeric_casts, 70 | unreachable_pub, 71 | unsafe_op_in_unsafe_fn, 72 | unused_crate_dependencies, 73 | unused_extern_crates, 74 | unused_import_braces, 75 | unused_lifetimes, 76 | unused_qualifications, 77 | unused_results, 78 | variant_size_differences 79 | )] 80 | // reasonable rustdoc lints 81 | #![warn( 82 | rustdoc::missing_crate_level_docs, 83 | rustdoc::missing_doc_code_examples, 84 | rustdoc::private_doc_tests, 85 | rustdoc::invalid_html_tags 86 | )] 87 | // false positives in `` blocks 88 | #![allow(clippy::doc_markdown)] 89 | 90 | //! [![crates.io]](https://crates.io/crates/async_fn_traits) 91 | //! [![github]](https://github.com/steffahn/async_fn_traits) 92 | //! [![MIT / Apache 2.0 licensed]](https://github.com/steffahn/async_fn_traits#License) 93 | //! [![unsafe forbidden]](https://github.com/rust-secure-code/safety-dance/) 94 | //! 95 | //! [github]: https://img.shields.io/badge/github-steffahn/async__fn__traits-yellowgreen.svg 96 | //! [crates.io]: https://img.shields.io/crates/v/async_fn_traits.svg 97 | //! [MIT / Apache 2.0 licensed]: https://img.shields.io/crates/l/async_fn_traits.svg 98 | //! [docs.rs]: https://docs.rs/async_fn_traits/badge.svg 99 | //! [unsafe forbidden]: https://img.shields.io/badge/unsafe-forbidden-success.svg 100 | //! 101 | //! Trait synonyms for `Fn[…]`-trait bounds of functions returning futures. 102 | //! 103 | //! E.g. a 2-argument function `async fn foo(x: Bar, y: Baz) -> Qux` will implement 104 | //! [AsyncFn2]. 105 | //! 106 | //! _TODO: This crate-level documentation is missing some code examples._ 107 | 108 | use core::future::Future; 109 | use paste::paste; 110 | 111 | #[allow(clippy::missing_docs_in_private_items)] 112 | macro_rules! define_async_fn_traits { 113 | ($($J:literal)+) => { 114 | define_async_fn_traits!{ 115 | [Once][] $($J)+ 116 | } 117 | define_async_fn_traits!{ 118 | [Mut][] $($J)+ 119 | } 120 | define_async_fn_traits!{ 121 | [][] $($J)+ 122 | } 123 | }; 124 | ([$($FNTYPE:ident)?][$($I:literal)*] $N:literal $($J:literal)*) => { 125 | paste!{ 126 | #[doc = "A synonym for future-returning `Fn"$($FNTYPE)?"`-bounds with "$N" arguments"] 127 | #[doc = ""] 128 | #[doc = "The bound"] 129 | #[doc = "```no_run"] 130 | #[doc = "# use async_fn_traits::*;"] 131 | #[doc = "# fn _f])", "*">() where"] 132 | #[doc = "F: AsyncFn"$($FNTYPE)?$N"<"$([]", ")*"Output = R>,"] 133 | #[doc = "# {}"] 134 | #[doc = "```"] 135 | #[doc = "is equivalent to something like"] 136 | #[doc = "```no_run"] 137 | #[doc = "# use core::future::Future;"] 138 | #[doc = "# fn _f])", "*">() where"] 139 | #[doc = "F: Fn"$($FNTYPE)?"("$([])", "*") -> Fut,"] 140 | #[doc = "Fut: Future,"] 141 | #[doc = "# {}"] 142 | #[doc = "```"] 143 | pub trait []<$([]),*> 144 | : []($([]),*) -> ]<$([]),*>>::OutputFuture 145 | { 146 | #[allow(missing_docs)] 147 | type OutputFuture: Future]<$([]),*>>::Output>; 148 | #[allow(missing_docs)] 149 | type Output; 150 | } 151 | impl]),*> []<$([]),*> for F 152 | where 153 | F: []($([]),*) -> Fut, 154 | Fut: Future, 155 | { 156 | type OutputFuture = Fut; 157 | type Output = Fut::Output; 158 | } 159 | } 160 | define_async_fn_traits!{ 161 | [$($FNTYPE)?][$($I)* $N] $($J)* 162 | } 163 | }; 164 | ([$($FNTYPE:ident)?][$($I:literal)*]) => {}; 165 | } 166 | 167 | define_async_fn_traits!(0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15); 168 | --------------------------------------------------------------------------------