diff --git a/.spelling b/.spelling index e9ceb2a8..f18571d7 100644 --- a/.spelling +++ b/.spelling @@ -37,6 +37,7 @@ btree_map buildable bytesbuf callee +cancelled Cargo.toml C-BITFLAG C-CONV @@ -235,6 +236,7 @@ shareable skimmable SLAs smallvec +spawner startup stderr stdlib diff --git a/CHANGELOG.md b/CHANGELOG.md index 9862cfa6..03cb048a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ Please see each crate's change log below: +- [`anyspawn`](./crates/anyspawn/CHANGELOG.md) - [`bytesbuf`](./crates/bytesbuf/CHANGELOG.md) - [`bytesbuf_io`](./crates/bytesbuf_io/CHANGELOG.md) - [`data_privacy`](./crates/data_privacy/CHANGELOG.md) diff --git a/Cargo.lock b/Cargo.lock index 0022259b..4e6375fd 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -13,9 +13,9 @@ dependencies = [ [[package]] name = "alloc_tracker" -version = "0.5.12" +version = "0.5.14" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "541f3dfa28da9fba29d46a58d1fc137d401b7cdd5fff76c2cdc03abe3ad5d87c" +checksum = "6d6f8b0cbd2617bdb93d237d7e11032f0ec3ea509ce1fbd351397567e36dd6d6" [[package]] name = "android_system_properties" @@ -38,6 +38,144 @@ version = "1.0.13" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "5192cca8006f1fd4f7237516f40fa183bb07f8fbdfedaa0036de5ea9b0b45e78" +[[package]] +name = "anyspawn" +version = "0.1.0" +dependencies = [ + "criterion", + "futures", + "futures-channel", + "smol", + "static_assertions", + "tick", + "tokio", +] + +[[package]] +name = "async-channel" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "924ed96dd52d1b75e9c1a3e6275715fd320f5f9439fb5a4a11fa51f4221158d2" +dependencies = [ + "concurrent-queue", + "event-listener-strategy", + "futures-core", + "pin-project-lite", +] + +[[package]] +name = "async-executor" +version = "1.13.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "497c00e0fd83a72a79a39fcbd8e3e2f055d6f6c7e025f3b3d91f4f8e76527fb8" +dependencies = [ + "async-task", + "concurrent-queue", + "fastrand", + "futures-lite", + "pin-project-lite", + "slab", +] + +[[package]] +name = "async-fs" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8034a681df4aed8b8edbd7fbe472401ecf009251c8b40556b304567052e294c5" +dependencies = [ + "async-lock", + "blocking", + "futures-lite", +] + +[[package]] +name = "async-io" +version = "2.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "456b8a8feb6f42d237746d4b3e9a178494627745c3c56c6ea55d92ba50d026fc" +dependencies = [ + "autocfg", + "cfg-if", + "concurrent-queue", + "futures-io", + "futures-lite", + "parking", + "polling", + "rustix", + "slab", + "windows-sys 0.61.2", +] + +[[package]] +name = "async-lock" +version = "3.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "290f7f2596bd5b78a9fec8088ccd89180d7f9f55b94b0576823bbbdc72ee8311" +dependencies = [ + "event-listener", + "event-listener-strategy", + "pin-project-lite", +] + +[[package]] +name = "async-net" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b948000fad4873c1c9339d60f2623323a0cfd3816e5181033c6a5cb68b2accf7" +dependencies = [ + "async-io", + "blocking", + "futures-lite", +] + +[[package]] +name = "async-process" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc50921ec0055cdd8a16de48773bfeec5c972598674347252c0399676be7da75" +dependencies = [ + "async-channel", + "async-io", + "async-lock", + "async-signal", + "async-task", + "blocking", + "cfg-if", + "event-listener", + "futures-lite", + "rustix", +] + +[[package]] +name = "async-signal" +version = "0.2.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "43c070bbf59cd3570b6b2dd54cd772527c7c3620fce8be898406dd3ed6adc64c" +dependencies = [ + "async-io", + "async-lock", + "atomic-waker", + "cfg-if", + "futures-core", + "futures-io", + "rustix", + "signal-hook-registry", + "slab", + "windows-sys 0.61.2", +] + +[[package]] +name = "async-task" +version = "4.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8b75356056920673b02621b35afd0f7dda9306d03c79a30f5c56c44cf256e3de" + +[[package]] +name = "atomic-waker" +version = "1.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0" + [[package]] name = "autocfg" version = "1.5.0" @@ -60,6 +198,19 @@ version = "2.10.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "812e12b5285cc515a9c72a5c1d3b6d46a19dac5acfef5265968c166106e31dd3" +[[package]] +name = "blocking" +version = "1.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e83f8d02be6967315521be875afa792a316e28d57b5a2d401897e2a7921b7f21" +dependencies = [ + "async-channel", + "async-task", + "futures-io", + "futures-lite", + "piper", +] + [[package]] name = "bumpalo" version = "3.19.1" @@ -119,9 +270,9 @@ checksum = "37b2a672a2cb129a2e41c10b1224bb368f9f37a2b16b612598138befd7b37eb5" [[package]] name = "cc" -version = "1.2.51" +version = "1.2.53" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7a0aeaff4ff1a90589618835a598e545176939b97874f7abc7851caa0618f203" +checksum = "755d2fce177175ffca841e9a06afdb2c4ab0f593d53b4dee48147dfaade85932" dependencies = [ "find-msvc-tools", "shlex", @@ -135,9 +286,9 @@ checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801" [[package]] name = "chrono" -version = "0.4.42" +version = "0.4.43" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "145052bdd345b87320e369255277e3fb5152762ad123a901ef5c262dd38fe8d2" +checksum = "fac4744fb15ae8337dc853fee7fb3f4e48c0fbaa23d0afe49c447b4fab126118" dependencies = [ "iana-time-zone", "num-traits", @@ -183,18 +334,18 @@ dependencies = [ [[package]] name = "clap" -version = "4.5.53" +version = "4.5.54" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c9e340e012a1bf4935f5282ed1436d1489548e8f72308207ea5df0e23d2d03f8" +checksum = "c6e6ff9dcd79cff5cd969a17a545d79e84ab086e444102a591e288a8aa3ce394" dependencies = [ "clap_builder", ] [[package]] name = "clap_builder" -version = "4.5.53" +version = "4.5.54" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d76b5d13eaa18c901fd2f7fca939fefe3a0727a953561fefdf3b2922b8569d00" +checksum = "fa42cf4d2b7a41bc8f663a7cab4031ebafa1bf3875705bfaf8466dc60ab52c00" dependencies = [ "anstyle", "clap_lex", @@ -202,9 +353,18 @@ dependencies = [ [[package]] name = "clap_lex" -version = "0.7.6" +version = "0.7.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a1d728cc89cf3aee9ff92b05e62b19ee65a02b5702cff7d5a377e32c6ae29d8d" +checksum = "c3e64b0cc0439b12df2fa678eae89a1c56a529fd067a9115f7827f1fffd22b32" + +[[package]] +name = "concurrent-queue" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ca0197aee26d1ae37445ee532fefce43251d24cc7c166799f4d46817f1d3973" +dependencies = [ + "crossbeam-utils", +] [[package]] name = "convert_case" @@ -223,13 +383,13 @@ checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b" [[package]] name = "cpulist" -version = "1.0.2" +version = "1.0.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "11a45acbbf4646bcff1e38cfd1f7d88ae73353d4add7ca31609023216599bbfa" +checksum = "10921f832bb6e2075c6910ab0be7b33e413029ae6d74b01f049fc6cb237362e6" dependencies = [ "itertools 0.14.0", "new_zealand", - "thiserror 2.0.17", + "thiserror 2.0.18", ] [[package]] @@ -263,6 +423,12 @@ dependencies = [ "itertools 0.13.0", ] +[[package]] +name = "crossbeam-utils" +version = "0.8.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d0a5c400df2834b80a4c3327b3aad3a4c4cd4de0629063962b03235697506a28" + [[package]] name = "crunchy" version = "0.2.4" @@ -397,6 +563,27 @@ dependencies = [ "windows-sys 0.61.2", ] +[[package]] +name = "event-listener" +version = "5.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e13b66accf52311f30a0db42147dadea9850cb48cd070028831ae5f5d4b856ab" +dependencies = [ + "concurrent-queue", + "parking", + "pin-project-lite", +] + +[[package]] +name = "event-listener-strategy" +version = "0.5.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8be9f3dfaaffdae2972880079a491a1a8bb7cbed0b8dd7a347f668b4150a3b93" +dependencies = [ + "event-listener", + "pin-project-lite", +] + [[package]] name = "fastrand" version = "2.3.0" @@ -405,9 +592,9 @@ checksum = "37909eebbb50d72f9059c3b6d82c0463f2ff062c9e95845c43a6c9c0355411be" [[package]] name = "find-msvc-tools" -version = "0.1.6" +version = "0.1.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "645cbb3a84e60b7531617d5ae4e57f7e27308f6445f5abf653209ea76dec8dff" +checksum = "8591b0bcc8a98a64310a2fae1bb3e9b8564dd10e381e6e28010fde8e8e8568db" [[package]] name = "foldhash" @@ -417,9 +604,9 @@ checksum = "77ce24cb58228fbb8aa041425bb1050850ac19177686ea6e0f41a70416f56fdb" [[package]] name = "folo_ffi" -version = "0.1.8" +version = "0.1.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "44b0401f7b448a28be3e723e6a30cd29ebe707ebbf23ac01ab505da0de10005c" +checksum = "b2c4a9efbd06c6c8500f5d97a20159996679088bdb5f598a863960bedf3f2574" [[package]] name = "fragile" @@ -503,6 +690,19 @@ version = "0.3.31" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9e5c1b78ca4aae1ac06c48a526a655760685149f0d465d21f37abfe57ce075c6" +[[package]] +name = "futures-lite" +version = "2.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f78e10609fe0e0b3f4157ffab1876319b5b0db102a2c60dc4626306dc46b44ad" +dependencies = [ + "fastrand", + "futures-core", + "futures-io", + "parking", + "pin-project-lite", +] + [[package]] name = "futures-macro" version = "0.3.31" @@ -598,6 +798,12 @@ dependencies = [ "stable_deref_trait", ] +[[package]] +name = "hermit-abi" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc0fef456e4baa96da950455cd02c081ca953b141298e41db3fc7e36b1da849c" + [[package]] name = "iana-time-zone" version = "0.1.64" @@ -624,9 +830,9 @@ dependencies = [ [[package]] name = "indexmap" -version = "2.12.1" +version = "2.13.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0ad4bb2b565bca0645f4d68c5c9af97fba094e9791da685bf83cb5f3ce74acf2" +checksum = "7714e70437a7dc3ac8eb7e6f8df75fd8eb422675fc7678aff7364301092b1017" dependencies = [ "equivalent", "hashbrown", @@ -634,9 +840,9 @@ dependencies = [ [[package]] name = "infinity_pool" -version = "0.8.4" +version = "0.8.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6f81221d9c547a962679935ef10f3be03739f8a99c98ad7bfc1fcbd4850892bf" +checksum = "1b53f0294af2d25dc8eee1d483579ad476233efe0ce1e09c1721275a976d7055" dependencies = [ "new_zealand", "num-integer", @@ -646,9 +852,9 @@ dependencies = [ [[package]] name = "insta" -version = "1.45.1" +version = "1.46.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "983e3b24350c84ab8a65151f537d67afbbf7153bb9f1110e03e9fa9b07f67a5c" +checksum = "248b42847813a1550dafd15296fd9748c651d0c32194559dbc05d804d54b21e8" dependencies = [ "once_cell", "serde", @@ -682,9 +888,9 @@ checksum = "92ecc6618181def0457392ccd0ee51198e065e016d1d527a7ac1b6dc7c1f09d2" [[package]] name = "jiff" -version = "0.2.17" +version = "0.2.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a87d9b8105c23642f50cbbae03d1f75d8422c5cb98ce7ee9271f7ff7505be6b8" +checksum = "e67e8da4c49d6d9909fe03361f9b620f58898859f5c7aded68351e85e71ecf50" dependencies = [ "jiff-static", "jiff-tzdb-platform", @@ -697,9 +903,9 @@ dependencies = [ [[package]] name = "jiff-static" -version = "0.2.17" +version = "0.2.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b787bebb543f8969132630c51fd0afab173a86c6abae56ff3b9e5e3e3f9f6e58" +checksum = "e0c84ee7f197eca9a86c6fd6cb771e55eb991632f15f2bc3ca6ec838929e6e78" dependencies = [ "proc-macro2", "quote", @@ -723,9 +929,9 @@ dependencies = [ [[package]] name = "js-sys" -version = "0.3.83" +version = "0.3.85" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "464a3709c7f55f1f721e5389aa6ea4e3bc6aba669353300af094b29ffbdde1d8" +checksum = "8c942ebf8e95485ca0d52d97da7c5a2c387d0e7f0ba4c35e93bfcaee045955b3" dependencies = [ "once_cell", "wasm-bindgen", @@ -756,9 +962,9 @@ checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe" [[package]] name = "libc" -version = "0.2.178" +version = "0.2.180" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "37c93d8daa9d8a012fd8ab92f088405fb202ea0b6ab73ee2482ae66af4f42091" +checksum = "bcc35a38544a891a5f7c865aca548a982ccb3b8650a5b06d0fd33a10283c56fc" [[package]] name = "linux-raw-sys" @@ -783,9 +989,9 @@ checksum = "5e5032e24019045c762d3c0f28f5b6b8bbf38563a65908389bf7978758920897" [[package]] name = "many_cpus" -version = "1.1.3" +version = "1.1.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fb82f238dc324f74bb9c2e25b4244dbdeab8d66809dc3e988472498e84a411ec" +checksum = "d4ab614fc8e14ffa2aab66ed7942362b33191752f3a5bf9533e9f88e4204545f" dependencies = [ "cpulist", "derive_more", @@ -853,15 +1059,15 @@ dependencies = [ [[package]] name = "new_zealand" -version = "1.0.2" +version = "1.0.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "62cc3bfd31ca5136b8449b5418a91a9c2a336b3ea61ae17eae350c10bd4ab26d" +checksum = "e098f45dda35490b475350685c55a9fb4c4f6cb885f6f0b09fea301cfef52161" [[package]] name = "nm" -version = "0.1.22" +version = "0.1.26" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "19e593410e637cfb2542a21f30106fde38fcf7bb8359b39c1355d382ad09f888" +checksum = "93ee800dec1976af03cfa4c209e0fac85e140266782719f06bddfd321177acf9" dependencies = [ "foldhash", "new_zealand", @@ -915,7 +1121,7 @@ dependencies = [ "mutants", "ohno_macros", "regex", - "thiserror 2.0.17", + "thiserror 2.0.18", "tokio", "typeid", ] @@ -954,6 +1160,12 @@ dependencies = [ "windows-sys 0.61.2", ] +[[package]] +name = "parking" +version = "2.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f38d5652c16fde515bb1ecef450ab0f6a219d619a7274976324d5e377f7dceba" + [[package]] name = "parking_lot" version = "0.12.5" @@ -1060,6 +1272,31 @@ version = "0.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "8b870d8c151b6f2fb93e84a13146138f05d02ed11c7e7c54f8826aaaf7c9f184" +[[package]] +name = "piper" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "96c8c490f422ef9a4efd2cb5b42b76c8613d7e7dfc1caf667b8a3350a5acc066" +dependencies = [ + "atomic-waker", + "fastrand", + "futures-io", +] + +[[package]] +name = "polling" +version = "3.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5d0e4f59085d47d8241c88ead0f274e8a0cb551f3625263c05eb8dd897c34218" +dependencies = [ + "cfg-if", + "concurrent-queue", + "hermit-abi", + "pin-project-lite", + "rustix", + "windows-sys 0.61.2", +] + [[package]] name = "portable-atomic" version = "1.13.0" @@ -1128,18 +1365,18 @@ dependencies = [ [[package]] name = "proc-macro2" -version = "1.0.104" +version = "1.0.106" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9695f8df41bb4f3d222c95a67532365f569318332d03d5f3f67f37b20e6ebdf0" +checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934" dependencies = [ "unicode-ident", ] [[package]] name = "quote" -version = "1.0.42" +version = "1.0.43" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a338cc41d27e6cc6dce6cefc13a0729dfbb81c262b1f519331575dd80ef3067f" +checksum = "dc74d9a594b72ae6656596548f56f667211f8a97b3d4c3d467150794690dc40a" dependencies = [ "proc-macro2", ] @@ -1166,7 +1403,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "6db2770f06117d490610c7488547d543617b21bfa07796d7a12f6f1bd53850d1" dependencies = [ "rand_chacha", - "rand_core 0.9.3", + "rand_core 0.9.5", ] [[package]] @@ -1176,7 +1413,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d3022b5f1df60f26e1ffddd6c66e8aa15de382ae63b3a0c1bfc0e4d3e3f325cb" dependencies = [ "ppv-lite86", - "rand_core 0.9.3", + "rand_core 0.9.5", ] [[package]] @@ -1187,18 +1424,18 @@ checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c" [[package]] name = "rand_core" -version = "0.9.3" +version = "0.9.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "99d9a13982dcf210057a8a78572b2217b667c3beacbf3a0d8b454f6f82837d38" +checksum = "76afc826de14238e6e8c374ddcc1fa19e374fd8dd986b0d2af0d02377261d83c" dependencies = [ "getrandom", ] [[package]] name = "rapidhash" -version = "4.2.0" +version = "4.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2988730ee014541157f48ce4dcc603940e00915edc3c7f9a8d78092256bb2493" +checksum = "5d8b5b858a440a0bc02625b62dd95131b9201aa9f69f411195dd4a7cfb1de3d7" dependencies = [ "rustversion", ] @@ -1348,9 +1585,9 @@ dependencies = [ [[package]] name = "serde_json" -version = "1.0.148" +version = "1.0.149" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3084b546a1dd6289475996f182a22aba973866ea8e8b02c51d9f46b1336a22da" +checksum = "83fc039473c5595ace860d8c4fafa220ff474b3fc6bfdb4293327f1a37e94d86" dependencies = [ "itoa", "memchr", @@ -1399,6 +1636,16 @@ version = "1.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64" +[[package]] +name = "signal-hook-registry" +version = "1.4.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c4db69cba1110affc0e9f7bcd48bbf87b3f4fc7c61fc9155afd4c469eb3d6c1b" +dependencies = [ + "errno", + "libc", +] + [[package]] name = "similar" version = "2.7.0" @@ -1423,6 +1670,23 @@ version = "1.15.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "67b1b7a3b5fe4f1376887184045fcf45c69e92af734b7aaddc05fb777b6fbd03" +[[package]] +name = "smol" +version = "2.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a33bd3e260892199c3ccfc487c88b2da2265080acb316cd920da72fdfd7c599f" +dependencies = [ + "async-channel", + "async-executor", + "async-fs", + "async-io", + "async-lock", + "async-net", + "async-process", + "blocking", + "futures-lite", +] + [[package]] name = "stable_deref_trait" version = "1.2.1" @@ -1437,9 +1701,9 @@ checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f" [[package]] name = "syn" -version = "2.0.111" +version = "2.0.114" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "390cc9a294ab71bdb1aa2e99d13be9c753cd2d7bd6560c77118597410c4d2e87" +checksum = "d4d107df263a3013ef9b1879b0df87d706ff80f65a86ea879bd9c31f9b307c2a" dependencies = [ "proc-macro2", "quote", @@ -1508,11 +1772,11 @@ dependencies = [ [[package]] name = "thiserror" -version = "2.0.17" +version = "2.0.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f63587ca0f12b72a0600bcba1d40081f830876000bb46dd2337a3051618f4fc8" +checksum = "4288b5bcbc7920c07a1149a35cf9590a2aa808e0bc1eafaade0b80947865fbc4" dependencies = [ - "thiserror-impl 2.0.17", + "thiserror-impl 2.0.18", ] [[package]] @@ -1528,9 +1792,9 @@ dependencies = [ [[package]] name = "thiserror-impl" -version = "2.0.17" +version = "2.0.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3ff15c8ecd7de3849db632e14d18d2571fa09dfc5ed93479bc4485c7a517c913" +checksum = "ebc4ee7f67670e9b64d05fa4253e753e016c6c95ff35b89b7941d6b856dec1d5" dependencies = [ "proc-macro2", "quote", @@ -1600,9 +1864,9 @@ dependencies = [ [[package]] name = "time" -version = "0.3.44" +version = "0.3.45" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "91e7d9e3bb61134e77bde20dd4825b97c010155709965fedf0f49bb138e52a9d" +checksum = "f9e442fc33d7fdb45aa9bfeb312c095964abdf596f7567261062b2a7107aaabd" dependencies = [ "deranged", "itoa", @@ -1611,22 +1875,22 @@ dependencies = [ "num-conv", "num_threads", "powerfmt", - "serde", + "serde_core", "time-core", "time-macros", ] [[package]] name = "time-core" -version = "0.1.6" +version = "0.1.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "40868e7c1d2f0b8d73e4a8c7f0ff63af4f6d19be117e90bd73eb1d62cf831c6b" +checksum = "8b36ee98fd31ec7426d599183e8fe26932a8dc1fb76ddb6214d05493377d34ca" [[package]] name = "time-macros" -version = "0.2.24" +version = "0.2.25" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "30cfb0125f12d9c277f35663a0a33f8c30190f4e4574868a330595412d34ebf3" +checksum = "71e552d1249bf61ac2a52db88179fd0673def1e1ad8243a00d9ec9ed71fee3dd" dependencies = [ "num-conv", "time-core", @@ -1663,9 +1927,9 @@ dependencies = [ [[package]] name = "tokio" -version = "1.48.0" +version = "1.49.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ff360e02eab121e0bc37a2d3b4d4dc622e6eda3a8e5253d5435ecf5bd4c68408" +checksum = "72a2903cd7736441aac9df9d7688bd0ce48edccaadf181c3b90be801e81d3d86" dependencies = [ "pin-project-lite", "tokio-macros", @@ -1684,9 +1948,9 @@ dependencies = [ [[package]] name = "tokio-util" -version = "0.7.17" +version = "0.7.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2efa149fe76073d6e8fd97ef4f4eca7b67f599660115591483572e406e165594" +checksum = "9ae9cec805b01e8fc3fd2fe289f89149a9b66dd16786abd8b19cfa7b48cb0098" dependencies = [ "bytes", "futures-core", @@ -1697,9 +1961,9 @@ dependencies = [ [[package]] name = "toml" -version = "0.9.10+spec-1.1.0" +version = "0.9.11+spec-1.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0825052159284a1a8b4d6c0c86cbc801f2da5afd2b225fa548c72f2e74002f48" +checksum = "f3afc9a848309fe1aaffaed6e1546a7a14de1f935dc9d89d32afd9a44bab7c46" dependencies = [ "indexmap", "serde_core", @@ -1736,9 +2000,9 @@ checksum = "ab16f14aed21ee8bfd8ec22513f7287cd4a91aa92e44edfe2c17ddd004e92607" [[package]] name = "tower" -version = "0.5.2" +version = "0.5.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d039ad9159c98b70ecfd540b2573b97f7f52c3e8d9f8ad57a24b916a536975f9" +checksum = "ebe5ef63511595f1344e2d5cfa636d973292adc0eec1f0ad45fae9f0851ab1d4" dependencies = [ "futures-core", "futures-util", @@ -1855,18 +2119,18 @@ dependencies = [ [[package]] name = "wasip2" -version = "1.0.1+wasi-0.2.4" +version = "1.0.2+wasi-0.2.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0562428422c63773dad2c345a1882263bbf4d65cf3f42e90921f787ef5ad58e7" +checksum = "9517f9239f02c069db75e65f174b3da828fe5f5b945c4dd26bd25d89c03ebcf5" dependencies = [ "wit-bindgen", ] [[package]] name = "wasm-bindgen" -version = "0.2.106" +version = "0.2.108" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0d759f433fa64a2d763d1340820e46e111a7a5ab75f993d1852d70b03dbb80fd" +checksum = "64024a30ec1e37399cf85a7ffefebdb72205ca1c972291c51512360d90bd8566" dependencies = [ "cfg-if", "once_cell", @@ -1877,9 +2141,9 @@ dependencies = [ [[package]] name = "wasm-bindgen-macro" -version = "0.2.106" +version = "0.2.108" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "48cb0d2638f8baedbc542ed444afc0644a29166f1595371af4fecf8ce1e7eeb3" +checksum = "008b239d9c740232e71bd39e8ef6429d27097518b6b30bdf9086833bd5b6d608" dependencies = [ "quote", "wasm-bindgen-macro-support", @@ -1887,9 +2151,9 @@ dependencies = [ [[package]] name = "wasm-bindgen-macro-support" -version = "0.2.106" +version = "0.2.108" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cefb59d5cd5f92d9dcf80e4683949f15ca4b511f4ac0a6e14d4e1ac60c6ecd40" +checksum = "5256bae2d58f54820e6490f9839c49780dff84c65aeab9e772f15d5f0e913a55" dependencies = [ "bumpalo", "proc-macro2", @@ -1900,9 +2164,9 @@ dependencies = [ [[package]] name = "wasm-bindgen-shared" -version = "0.2.106" +version = "0.2.108" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cbc538057e648b67f72a982e708d485b2efa771e1ac05fec311f9f63e5800db4" +checksum = "1f01b580c9ac74c8d8f0c0e4afb04eeef2acf145458e52c03845ee9cd23e3d12" dependencies = [ "unicode-ident", ] @@ -2160,9 +2424,9 @@ checksum = "5a5364e9d77fcdeeaa6062ced926ee3381faa2ee02d3eb83a5c27a8825540829" [[package]] name = "wit-bindgen" -version = "0.46.0" +version = "0.51.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f17a85883d4e6d00e8a97c586de764dabcc06133f7f1d55dce5cdc070ad7fe59" +checksum = "d7249219f66ced02969388cf2bb044a09756a083d0fab1e566056b04d9fbcaa5" [[package]] name = "xml-rs" @@ -2178,18 +2442,18 @@ checksum = "fdd20c5420375476fbd4394763288da7eb0cc0b8c11deed431a91562af7335d3" [[package]] name = "zerocopy" -version = "0.8.31" +version = "0.8.33" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fd74ec98b9250adb3ca554bdde269adf631549f51d8a8f8f0a10b50f1cb298c3" +checksum = "668f5168d10b9ee831de31933dc111a459c97ec93225beb307aed970d1372dfd" dependencies = [ "zerocopy-derive", ] [[package]] name = "zerocopy-derive" -version = "0.8.31" +version = "0.8.33" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d8a8d209fdf45cf5138cbb5a506f6b52522a25afccc534d1475dad8e31105c6a" +checksum = "2c7962b26b0a8685668b671ee4b54d007a67d4eaf05fda79ac0ecf41e32270f1" dependencies = [ "proc-macro2", "quote", @@ -2198,6 +2462,6 @@ dependencies = [ [[package]] name = "zmij" -version = "1.0.3" +version = "1.0.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e9747e91771f56fd7893e1164abd78febd14a670ceec257caad15e051de35f06" +checksum = "dfcd145825aace48cff44a8844de64bf75feec3080e0aa5cdbde72961ae51a65" diff --git a/Cargo.toml b/Cargo.toml index 26dcf70c..62222ce0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -24,6 +24,7 @@ repository = "https://github.com/microsoft/oxidizer" [workspace.dependencies] # local dependencies +anyspawn = { path = "crates/anyspawn", default-features = false, version = "0.1.0" } bytesbuf = { path = "crates/bytesbuf", default-features = false, version = "0.2.2" } bytesbuf_io = { path = "crates/bytesbuf_io", default-features = false, version = "0.1.1" } data_privacy = { path = "crates/data_privacy", default-features = false, version = "0.10.1" } @@ -52,6 +53,7 @@ derive_more = { version = "2.0.1", default-features = false } duct = { version = "1.1.1", default-features = false } dynosaur = { version = "0.3.0", default-features = false } futures = { version = "0.3.31", default-features = false } +futures-channel = { version = "0.3.31", default-features = false } futures-core = { version = "0.3.31", default-features = false } futures-util = { version = "0.3.31", default-features = false } infinity_pool = { version = "0.8.1", default-features = false } diff --git a/README.md b/README.md index 0085af2e..0b4c7817 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ This repository contains a set of crates that help you build robust highly scala These are the primary crates built out of this repo: +- [`anyspawn`](./crates/anyspawn/README.md) - Async runtime abstractions. - [`bytesbuf`](./crates/bytesbuf/README.md) - Types for creating and manipulating byte sequences. - [`bytesbuf_io`](./crates/bytesbuf_io/README.md) - Asynchronous I/O abstractions expressed via `bytesbuf` types. - [`data_privacy`](./crates/data_privacy/README.md) - Mechanisms to classify, manipulate, and redact sensitive data. diff --git a/crates/anyspawn/CHANGELOG.md b/crates/anyspawn/CHANGELOG.md new file mode 100644 index 00000000..d0cc418f --- /dev/null +++ b/crates/anyspawn/CHANGELOG.md @@ -0,0 +1,8 @@ +# Changelog + +## 0.1.0 + +Initial release. + +- `Spawner` trait for abstracting async task spawning across runtimes +- `TokioSpawner` implementation for the Tokio runtime (requires `tokio` feature) diff --git a/crates/anyspawn/Cargo.toml b/crates/anyspawn/Cargo.toml new file mode 100644 index 00000000..a3b63b4c --- /dev/null +++ b/crates/anyspawn/Cargo.toml @@ -0,0 +1,53 @@ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. + +[package] +name = "anyspawn" +description = "A generic task spawner compatible with any async runtime" +version = "0.1.0" +readme = "README.md" +keywords = ["oxidizer", "async", "runtime", "futures"] +categories = ["Asynchronous"] + +edition.workspace = true +rust-version.workspace = true +authors.workspace = true +license.workspace = true +homepage.workspace = true +repository.workspace = true + +[package.metadata.docs.rs] +all-features = true + +[features] +default = ["tokio"] +tokio = ["dep:tokio"] +custom = ["dep:futures-channel"] + +[dependencies] +futures-channel = { workspace = true, features = ["alloc"], optional = true } +tokio = { workspace = true, features = ["rt"], optional = true } + +[dev-dependencies] +criterion = { workspace = true } +futures = { workspace = true, features = ["executor"] } +smol = "2" +static_assertions.workspace = true +tick = { workspace = true, features = ["tokio"] } +tokio = { workspace = true, features = ["macros", "rt-multi-thread", "sync"] } + +[[bench]] +name = "spawner" +harness = false +required-features = ["tokio", "custom"] + +[[example]] +name = "custom" +required-features = ["tokio", "custom"] + +[[example]] +name = "tokio" +required-features = ["tokio"] + +[lints] +workspace = true diff --git a/crates/anyspawn/README.md b/crates/anyspawn/README.md new file mode 100644 index 00000000..e5cbffaa --- /dev/null +++ b/crates/anyspawn/README.md @@ -0,0 +1,66 @@ +
+ Anyspawn Logo + +# Anyspawn + +[![crate.io](https://img.shields.io/crates/v/anyspawn.svg)](https://crates.io/crates/anyspawn) +[![docs.rs](https://docs.rs/anyspawn/badge.svg)](https://docs.rs/anyspawn) +[![MSRV](https://img.shields.io/crates/msrv/anyspawn)](https://crates.io/crates/anyspawn) +[![CI](https://github.com/microsoft/oxidizer/actions/workflows/main.yml/badge.svg?event=push)](https://github.com/microsoft/oxidizer/actions/workflows/main.yml) +[![Coverage](https://codecov.io/gh/microsoft/oxidizer/graph/badge.svg?token=FCUG0EL5TI)](https://codecov.io/gh/microsoft/oxidizer) +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](../../LICENSE) +This crate was developed as part of the Oxidizer project + +
+ +Async runtime abstractions + +This crate provides a [`Spawner`][__link0] type that abstracts task spawning across +different async runtimes without generic infection. + +## Design Philosophy + +* **Concrete type**: No generics needed in your code +* **Simple**: Use built-in constructors or provide a closure +* **Flexible**: Works with any async runtime + +## Quick Start + +### Using Tokio + +```rust +use anyspawn::Spawner; + +let spawner = Spawner::tokio(); +let result = spawner.spawn(async { 1 + 1 }).await; +assert_eq!(result, 2); +``` + +### Custom Runtime + +```rust +use anyspawn::Spawner; + +let spawner = Spawner::custom(|fut| { + std::thread::spawn(move || futures::executor::block_on(fut)); +}); + +// Returns a JoinHandle that can be awaited or dropped +let handle = spawner.spawn(async { 42 }); +``` + +## Features + +* `tokio` (default): Enables the [`Spawner::tokio`][__link1] constructor +* `custom`: Enables the [`Spawner::custom`][__link2] constructor + + +
+ +This crate was developed as part of The Oxidizer Project. Browse this crate's source code. + + + [__cargo_doc2readme_dependencies_info]: ggGkYW0CYXSEGy4k8ldDFPOhG2VNeXtD5nnKG6EPY6OfW5wBG8g18NOFNdxpYXKEG-uxdJT263GuGzrWqTf_02hGG_fiPeXEDO8BG8LhU0Uc9qTPYWSBgmhhbnlzcGF3bmUwLjEuMA + [__link0]: https://docs.rs/anyspawn/0.1.0/anyspawn/?search=Spawner + [__link1]: https://docs.rs/anyspawn/0.1.0/anyspawn/?search=Spawner::tokio + [__link2]: https://docs.rs/anyspawn/0.1.0/anyspawn/?search=Spawner::custom diff --git a/crates/anyspawn/benches/spawner.rs b/crates/anyspawn/benches/spawner.rs new file mode 100644 index 00000000..87e7d464 --- /dev/null +++ b/crates/anyspawn/benches/spawner.rs @@ -0,0 +1,45 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +#![allow( + missing_docs, + clippy::unwrap_used, + reason = "Benchmarks don't require documentation and should fail fast on errors" +)] + +use anyspawn::Spawner; +use criterion::{Criterion, criterion_group, criterion_main}; + +fn entry(c: &mut Criterion) { + let mut group = c.benchmark_group("spawner"); + + // Tokio benchmarks + let rt = tokio::runtime::Runtime::new().unwrap(); + let tokio_spawner = Spawner::tokio(); + + group.bench_function("tokio_direct", |b| { + b.iter(|| rt.block_on(async { tokio::spawn(async { 42 }).await.unwrap() })); + }); + + group.bench_function("tokio_via_spawner", |b| { + b.iter(|| rt.block_on(async { tokio_spawner.spawn(async { 42 }).await })); + }); + + // smol benchmarks + let smol_spawner = Spawner::custom(|fut| { + smol::spawn(fut).detach(); + }); + + group.bench_function("smol_direct", |b| { + b.iter(|| smol::block_on(async { smol::spawn(async { 42 }).await })); + }); + + group.bench_function("smol_via_spawner", |b| { + b.iter(|| smol::block_on(async { smol_spawner.spawn(async { 42 }).await })); + }); + + group.finish(); +} + +criterion_group!(benches, entry); +criterion_main!(benches); diff --git a/crates/anyspawn/examples/custom.rs b/crates/anyspawn/examples/custom.rs new file mode 100644 index 00000000..e4647c3c --- /dev/null +++ b/crates/anyspawn/examples/custom.rs @@ -0,0 +1,32 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +//! Spawning tasks with a custom spawner. + +use std::time::Duration; + +use anyspawn::Spawner; + +#[tokio::main] +async fn main() { + // Create a spawner that runs futures on background threads + let spawner = Spawner::custom(|fut| { + std::thread::spawn(move || futures::executor::block_on(fut)); + }); + + // Fire-and-forget: spawn a task without waiting for its result + let () = spawner + .spawn(async { + std::thread::sleep(Duration::from_millis(10)); + println!("Background task completed!"); + }) + .await; + + // Retrieve a result by awaiting the JoinHandle + let handle = spawner.spawn(async { 1 + 1 }); + let value = futures::executor::block_on(handle); + println!("Got result: {value}"); + + // Wait for background task + std::thread::sleep(Duration::from_millis(50)); +} diff --git a/crates/anyspawn/examples/tokio.rs b/crates/anyspawn/examples/tokio.rs new file mode 100644 index 00000000..a32af76b --- /dev/null +++ b/crates/anyspawn/examples/tokio.rs @@ -0,0 +1,33 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +//! Spawning tasks with Tokio. + +use std::time::Duration; + +use anyspawn::Spawner; +use tick::Clock; + +#[tokio::main] +async fn main() { + let clock = Clock::new_tokio(); + let spawner = Spawner::tokio(); + + // Fire-and-forget: spawn a task without waiting for its result + let () = spawner + .spawn({ + let clock = clock.clone(); + async move { + clock.delay(Duration::from_millis(10)).await; + println!("Background task completed!"); + } + }) + .await; + + // Retrieve a result by awaiting the JoinHandle + let value = spawner.spawn(async { 1 + 1 }).await; + println!("Got result: {value}"); + + // Wait for background task + clock.delay(Duration::from_millis(50)).await; +} diff --git a/crates/anyspawn/favicon.ico b/crates/anyspawn/favicon.ico new file mode 100644 index 00000000..42c826b9 --- /dev/null +++ b/crates/anyspawn/favicon.ico @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f2a7cb259fa5c491b39fd9e2c2e32aa25497b818198957c7d1f90b02c896e524 +size 15406 diff --git a/crates/anyspawn/logo.png b/crates/anyspawn/logo.png new file mode 100644 index 00000000..ae2ae5ce --- /dev/null +++ b/crates/anyspawn/logo.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dfdc338b2229ac33c210aa8093128f2236c7a88d20eabce213b0f9b090fd24c8 +size 41426 diff --git a/crates/anyspawn/src/custom.rs b/crates/anyspawn/src/custom.rs new file mode 100644 index 00000000..398364b9 --- /dev/null +++ b/crates/anyspawn/src/custom.rs @@ -0,0 +1,29 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +use std::{fmt::Debug, pin::Pin, sync::Arc}; + +use futures_channel::oneshot; + +pub(crate) type BoxedFuture = Pin + Send>>; +type SpawnFn = dyn Fn(BoxedFuture) + Send + Sync; + +/// Internal wrapper for custom spawn functions. +#[derive(Clone)] +pub(crate) struct CustomSpawner(pub(crate) Arc); + +impl CustomSpawner { + pub(crate) fn call(&self, work: impl Future + Send + 'static) -> oneshot::Receiver { + let (tx, rx) = oneshot::channel(); + (self.0)(Box::pin(async move { + let _ = tx.send(work.await); + })); + rx + } +} + +impl Debug for CustomSpawner { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("CustomSpawner").finish_non_exhaustive() + } +} diff --git a/crates/anyspawn/src/handle.rs b/crates/anyspawn/src/handle.rs new file mode 100644 index 00000000..e64d4928 --- /dev/null +++ b/crates/anyspawn/src/handle.rs @@ -0,0 +1,49 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +//! [`JoinHandle`] for awaiting spawned task results. + +use std::{ + fmt::Debug, + pin::Pin, + task::{Context, Poll}, +}; + +#[cfg(feature = "custom")] +use futures_channel::oneshot; + +/// A handle to a spawned task that can be awaited to retrieve its result. +/// +/// This is returned by [`Spawner::spawn`](crate::Spawner::spawn) and implements +/// [`Future`] to allow awaiting the task's completion. +/// +/// # Panics +/// +/// Awaiting a `JoinHandle` will panic if the spawned task panicked. +pub struct JoinHandle(pub(crate) JoinHandleInner); + +pub(crate) enum JoinHandleInner { + #[cfg(feature = "tokio")] + Tokio(::tokio::task::JoinHandle), + #[cfg(feature = "custom")] + Custom(oneshot::Receiver), +} + +impl Future for JoinHandle { + type Output = T; + + fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll { + match &mut self.get_mut().0 { + #[cfg(feature = "tokio")] + JoinHandleInner::Tokio(jh) => Pin::new(jh).poll(cx).map(|res| res.expect("spawned task panicked")), + #[cfg(feature = "custom")] + JoinHandleInner::Custom(rx) => Pin::new(rx).poll(cx).map(|res| res.expect("spawned task panicked")), + } + } +} + +impl Debug for JoinHandle { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("JoinHandle").finish_non_exhaustive() + } +} diff --git a/crates/anyspawn/src/lib.rs b/crates/anyspawn/src/lib.rs new file mode 100644 index 00000000..f81b70c3 --- /dev/null +++ b/crates/anyspawn/src/lib.rs @@ -0,0 +1,65 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +#![cfg_attr(coverage_nightly, feature(coverage_attribute))] +#![cfg_attr(docsrs, feature(doc_cfg))] +#![warn(missing_docs)] + +//! Async runtime abstractions +//! +//! This crate provides a [`Spawner`] type that abstracts task spawning across +//! different async runtimes without generic infection. +//! +//! # Design Philosophy +//! +//! - **Concrete type**: No generics needed in your code +//! - **Simple**: Use built-in constructors or provide a closure +//! - **Flexible**: Works with any async runtime +//! +//! # Quick Start +//! +//! ## Using Tokio +//! +//! ```rust +//! use anyspawn::Spawner; +//! +//! # #[tokio::main] +//! # async fn main() { +//! let spawner = Spawner::tokio(); +//! let result = spawner.spawn(async { 1 + 1 }).await; +//! assert_eq!(result, 2); +//! # } +//! ``` +//! +//! ## Custom Runtime +//! +//! ```rust,ignore +//! use anyspawn::Spawner; +//! +//! let spawner = Spawner::custom(|fut| { +//! std::thread::spawn(move || futures::executor::block_on(fut)); +//! }); +//! +//! // Returns a JoinHandle that can be awaited or dropped +//! let handle = spawner.spawn(async { 42 }); +//! ``` +//! +//! # Features +//! +//! - `tokio` (default): Enables the [`Spawner::tokio`] constructor +//! - `custom`: Enables the [`Spawner::custom`] constructor + +#![doc(html_logo_url = "https://media.githubusercontent.com/media/microsoft/oxidizer/refs/heads/main/crates/anyspawn/logo.png")] +#![doc(html_favicon_url = "https://media.githubusercontent.com/media/microsoft/oxidizer/refs/heads/main/crates/anyspawn/favicon.ico")] + +#[cfg(feature = "custom")] +mod custom; +#[cfg(any(feature = "tokio", feature = "custom"))] +mod handle; +#[cfg(any(feature = "tokio", feature = "custom"))] +mod spawner; + +#[cfg(any(feature = "tokio", feature = "custom"))] +pub use handle::JoinHandle; +#[cfg(any(feature = "tokio", feature = "custom"))] +pub use spawner::Spawner; diff --git a/crates/anyspawn/src/spawner.rs b/crates/anyspawn/src/spawner.rs new file mode 100644 index 00000000..1adbfc67 --- /dev/null +++ b/crates/anyspawn/src/spawner.rs @@ -0,0 +1,187 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +//! [`Spawner`] for plugging in runtime implementations. + +use std::fmt::Debug; +#[cfg(feature = "custom")] +use std::sync::Arc; + +use crate::handle::JoinHandle; +#[cfg(any(feature = "tokio", feature = "custom"))] +use crate::handle::JoinHandleInner; + +#[cfg(feature = "custom")] +use crate::custom::{BoxedFuture, CustomSpawner}; + +/// Runtime-agnostic task spawner. +/// +/// `Spawner` abstracts task spawning across different async runtimes. Use the +/// built-in constructors for common runtimes, or [`Spawner::custom`] for custom +/// implementations. +/// +/// # Examples +/// +/// Using Tokio: +/// +/// ```rust +/// use anyspawn::Spawner; +/// +/// # #[tokio::main] +/// # async fn main() { +/// let spawner = Spawner::tokio(); +/// let handle = spawner.spawn(async { +/// println!("Task running!"); +/// }); +/// handle.await; // Wait for task to complete +/// # } +/// ``` +/// +/// ## Custom Runtime +/// +/// ```rust,ignore +/// use anyspawn::Spawner; +/// +/// let spawner = Spawner::custom(|fut| { +/// std::thread::spawn(move || futures::executor::block_on(fut)); +/// }); +/// +/// let handle = spawner.spawn(async { +/// println!("Running on custom runtime!"); +/// }); +/// // handle can be awaited or dropped (fire-and-forget) +/// ``` +/// +/// ## Getting Results +/// +/// Await the [`JoinHandle`](crate::JoinHandle) to retrieve a value from the task: +/// +/// ```rust +/// use anyspawn::Spawner; +/// +/// # #[tokio::main] +/// # async fn main() { +/// let spawner = Spawner::tokio(); +/// let value = spawner.spawn(async { 1 + 1 }).await; +/// assert_eq!(value, 2); +/// # } +/// ``` +/// +/// ## Handling Errors +/// +/// Return a `Result` from the task to propagate errors: +/// +/// ```rust +/// use anyspawn::Spawner; +/// +/// # #[tokio::main] +/// # async fn main() { +/// let spawner = Spawner::tokio(); +/// +/// let result = spawner +/// .spawn(async { +/// if true { Ok(42) } else { Err("something went wrong") } +/// }) +/// .await; +/// +/// match result { +/// Ok(value) => println!("Got {value}"), +/// Err(e) => eprintln!("Task failed: {e}"), +/// } +/// # } +/// ``` +#[derive(Debug, Clone)] +pub struct Spawner(SpawnerKind); + +#[derive(Debug, Clone)] +enum SpawnerKind { + #[cfg(feature = "tokio")] + Tokio, + #[cfg(feature = "custom")] + Custom(CustomSpawner), +} + +impl Spawner { + /// Creates a spawner that uses the Tokio runtime. + /// + /// # Panics + /// + /// Panics if called outside of a Tokio runtime context. + /// + /// # Examples + /// + /// ```rust + /// use anyspawn::Spawner; + /// + /// # #[tokio::main] + /// # async fn main() { + /// let spawner = Spawner::tokio(); + /// let result = spawner.spawn(async { 42 }).await; + /// assert_eq!(result, 42); + /// # } + /// ``` + #[must_use] + #[cfg(feature = "tokio")] + #[cfg_attr(docsrs, doc(cfg(feature = "tokio")))] + pub fn tokio() -> Self { + Self(SpawnerKind::Tokio) + } + + /// Creates a custom spawner from a closure. + /// + /// The closure receives a boxed, pinned future and is responsible for + /// spawning it on the appropriate runtime. + /// + /// # Examples + /// + /// ```rust,ignore + /// use anyspawn::Spawner; + /// + /// let spawner = Spawner::custom(|fut| { + /// std::thread::spawn(move || futures::executor::block_on(fut)); + /// }); + /// ``` + #[cfg(feature = "custom")] + #[cfg_attr(docsrs, doc(cfg(feature = "custom")))] + pub fn custom(f: F) -> Self + where + F: Fn(BoxedFuture) + Send + Sync + 'static, + { + Self(SpawnerKind::Custom(CustomSpawner(Arc::new(f)))) + } + + /// Spawns an async task on the runtime. + /// + /// Returns a [`JoinHandle`] that can be awaited to retrieve the task's result, + /// or dropped to run the task in fire-and-forget mode. + /// + /// # Panics + /// + /// Awaiting the returned `JoinHandle` will panic if the spawned task panics. + /// + /// # Examples + /// + /// ```rust + /// use anyspawn::Spawner; + /// + /// # #[tokio::main] + /// # async fn main() { + /// let spawner = Spawner::tokio(); + /// + /// // Await to get the result + /// let value = spawner.spawn(async { 1 + 1 }).await; + /// assert_eq!(value, 2); + /// + /// // Or fire-and-forget by dropping the handle + /// let _ = spawner.spawn(async { println!("background task") }); + /// # } + /// ``` + pub fn spawn(&self, work: impl Future + Send + 'static) -> JoinHandle { + match &self.0 { + #[cfg(feature = "tokio")] + SpawnerKind::Tokio => JoinHandle(JoinHandleInner::Tokio(::tokio::spawn(work))), + #[cfg(feature = "custom")] + SpawnerKind::Custom(c) => JoinHandle(JoinHandleInner::Custom(c.call(work))), + } + } +} diff --git a/crates/anyspawn/tests/handle.rs b/crates/anyspawn/tests/handle.rs new file mode 100644 index 00000000..16d489ae --- /dev/null +++ b/crates/anyspawn/tests/handle.rs @@ -0,0 +1,19 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +#![allow(missing_docs, reason = "test code")] +#![cfg(any(feature = "tokio", feature = "custom"))] + +//! Tests for `JoinHandle` implementations. + +use anyspawn::Spawner; + +#[cfg(feature = "tokio")] +#[tokio::test] +async fn join_handle_debug() { + let spawner = Spawner::tokio(); + let handle = spawner.spawn(async { 42 }); + let debug_str = format!("{handle:?}"); + assert!(debug_str.contains("JoinHandle")); + let _ = handle.await; +} diff --git a/crates/anyspawn/tests/spawner.rs b/crates/anyspawn/tests/spawner.rs new file mode 100644 index 00000000..521ae508 --- /dev/null +++ b/crates/anyspawn/tests/spawner.rs @@ -0,0 +1,71 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +#![allow(missing_docs, reason = "test code")] +#![cfg(any(feature = "tokio", feature = "custom"))] + +//! Tests for `Spawner` implementations. + +use anyspawn::Spawner; + +static_assertions::assert_impl_all!(Spawner: Send, Sync); + +#[cfg(feature = "tokio")] +#[tokio::test] +async fn tokio_spawn_and_await() { + let spawner = Spawner::tokio(); + let result = spawner.spawn(async { 42 }).await; + assert_eq!(result, 42); +} + +#[cfg(feature = "tokio")] +#[tokio::test] +async fn tokio_spawn_fire_and_forget() { + let spawner = Spawner::tokio(); + let (tx, rx) = tokio::sync::oneshot::channel(); + + let () = spawner + .spawn(async move { + tx.send(42).unwrap(); + }) + .await; + + assert_eq!(rx.await.unwrap(), 42); +} + +#[cfg(feature = "custom")] +#[test] +fn custom_spawn_and_await() { + let spawner = Spawner::custom(|fut| { + std::thread::spawn(move || futures::executor::block_on(fut)); + }); + + let result = futures::executor::block_on(spawner.spawn(async { 42 })); + assert_eq!(result, 42); +} + +#[cfg(feature = "custom")] +#[tokio::test] +async fn custom_spawn_fire_and_forget() { + let spawner = Spawner::custom(|fut| { + std::thread::spawn(move || futures::executor::block_on(fut)); + }); + + let (tx, rx) = std::sync::mpsc::channel(); + + let () = spawner + .spawn(async move { + tx.send(42).unwrap(); + }) + .await; + + assert_eq!(rx.recv().unwrap(), 42); +} + +#[cfg(feature = "custom")] +#[test] +fn custom_spawner_debug() { + let spawner = Spawner::custom(|_| {}); + let debug_str = format!("{spawner:?}"); + assert!(debug_str.contains("CustomSpawner")); +}