mirror of
https://github.com/tokio-rs/tokio.git
synced 2026-08-24 00:00:11 +02:00
Eliza Weisman
d456706528
## Motivation In many cases, it is desirable to spawn a set of tasks associated with keys, with the ability to cancel them by key. As an example use case for this sort of thing, see Tower's [`ReadyCache` type][1]. Now that PR #4530 adds a way of cancelling tasks in a `tokio::task::JoinSet`, we can implement a map-like API based on the same `IdleNotifiedSet` primitive. ## Solution This PR adds an implementation of a `JoinMap` type to `tokio_util::task`, using the `JoinSet` type from `tokio::task`, the `AbortHandle` type added in #4530, and the new task IDs added in #4630. Individual tasks can be aborted by key using the `JoinMap::abort` method, and a set of tasks whose key match a given predicate can be aborted using `JoinMap::abort_matching`. When tasks complete, `JoinMap::join_one` returns their associated key alongside the output from the spawned future, or the key and the `JoinError` if the task did not complete successfully. Overall, I think the way this works is pretty straightforward; much of this PR is just API boilerplate to implement the union of applicable APIs from `JoinSet` and `HashMap`. Unlike previous iterations on the `JoinMap` API (e.g. #4538), this version is implemented entirely in `tokio_util`, using only public APIs from the `tokio` crate. Currently, the required `tokio` APIs are unstable, but implementing `JoinMap` in `tokio-util` means we will never have to make stability commitments for the `JoinMap` API itself. [1]: https://github.com/tower-rs/tower/blob/master/tower/src/ready_cache/cache.rs Signed-off-by: Eliza Weisman <[email protected]>
62 lines
1.7 KiB
TOML
62 lines
1.7 KiB
TOML
[package]
|
|
name = "tokio-util"
|
|
# When releasing to crates.io:
|
|
# - Remove path dependencies
|
|
# - Update CHANGELOG.md.
|
|
# - Create "tokio-util-0.7.x" git tag.
|
|
version = "0.7.1"
|
|
edition = "2018"
|
|
rust-version = "1.49"
|
|
authors = ["Tokio Contributors <[email protected]>"]
|
|
license = "MIT"
|
|
repository = "https://github.com/tokio-rs/tokio"
|
|
homepage = "https://tokio.rs"
|
|
description = """
|
|
Additional utilities for working with Tokio.
|
|
"""
|
|
categories = ["asynchronous"]
|
|
|
|
[features]
|
|
# No features on by default
|
|
default = []
|
|
|
|
# Shorthand for enabling everything
|
|
full = ["codec", "compat", "io-util", "time", "net", "rt"]
|
|
|
|
net = ["tokio/net"]
|
|
compat = ["futures-io",]
|
|
codec = ["tracing"]
|
|
time = ["tokio/time","slab"]
|
|
io = []
|
|
io-util = ["io", "tokio/rt", "tokio/io-util"]
|
|
rt = ["tokio/rt", "tokio/sync", "futures-util", "hashbrown"]
|
|
|
|
__docs_rs = ["futures-util"]
|
|
|
|
[dependencies]
|
|
tokio = { version = "1.18.0", path = "../tokio", features = ["sync"] }
|
|
bytes = "1.0.0"
|
|
futures-core = "0.3.0"
|
|
futures-sink = "0.3.0"
|
|
futures-io = { version = "0.3.0", optional = true }
|
|
futures-util = { version = "0.3.0", optional = true }
|
|
pin-project-lite = "0.2.0"
|
|
slab = { version = "0.4.4", optional = true } # Backs `DelayQueue`
|
|
tracing = { version = "0.1.25", default-features = false, features = ["std"], optional = true }
|
|
|
|
[target.'cfg(tokio_unstable)'.dependencies]
|
|
hashbrown = { version = "0.12.0", optional = true }
|
|
|
|
[dev-dependencies]
|
|
tokio = { version = "1.0.0", path = "../tokio", features = ["full"] }
|
|
tokio-test = { version = "0.4.0", path = "../tokio-test" }
|
|
tokio-stream = { version = "0.1", path = "../tokio-stream" }
|
|
|
|
async-stream = "0.3.0"
|
|
futures = "0.3.0"
|
|
futures-test = "0.3.5"
|
|
|
|
[package.metadata.docs.rs]
|
|
all-features = true
|
|
rustdoc-args = ["--cfg", "docsrs"]
|