executor: add TypedExecutor #993
Conversation
tokio-executor/src/typed.rs
Outdated
| pub trait TypedExecutor<T> { | ||
|
|
||
| /// TODO: DOX | ||
| fn typed_spawn(&mut self, future: T) -> Result<(), SpawnError>; |
There was a problem hiding this comment.
I have a minor preference for naming this method spawn.
There was a problem hiding this comment.
I opted for typed_spawn to avoid name conflicts since most types that impl Executor will also implement TypedExecutor. Still prefer spawn?
There was a problem hiding this comment.
I figured that's why you did, but I expect only 1 trait would be imported, and so typed_spawn reads weird.
There was a problem hiding this comment.
I'm ok w/ switching it to spawn.
| @@ -21,3 +21,6 @@ members = [ | |||
| "tokio-udp", | |||
| "tokio-uds", | |||
| ] | |||
|
|
|||
| [patch.crates-io] | |||
| tokio-executor = { path = "tokio-executor" } | |||
There was a problem hiding this comment.
Prevent sub-crates that do not depend on the change from pulling in tokio-executor from crates.io.
|
|
||
| # Remove any existing patch statements | ||
| mv Cargo.toml Cargo.toml.bck | ||
| sed -n '/\[patch.crates-io\]/q;p' Cargo.toml.bck > Cargo.toml |
There was a problem hiding this comment.
Handle the case when the primary Cargo.toml file has a patch section already. This is now extracted into a dedicated file in order to reuse from multiple spots.
| /// * An executor has been shutdown and can no longer accept new futures. This | ||
| /// error state is expected to be permanent. | ||
| #[derive(Debug)] | ||
| pub struct SpawnError { |
There was a problem hiding this comment.
SpawnError is moved into its own file. No changes are made.
| use futures::Future; | ||
| use SpawnError; | ||
|
|
||
| /// A value that executes futures. |
There was a problem hiding this comment.
Executor is moved into its own file. No changes are made.
#993 introduces changes in a sub crate that other Tokio crates depend on. To make CI pass, a `[patch]` statement and `path` dependencies are used. When releasing, these must be removed. However, the commit that removes them and prepares the crates for release will not be able to pass CI. This commit adds a conditional on a special `[ci-release]` snippet in the commit message. If this exists, CI is only run with the full "patched" dependencies.
Add a
TypedExecutor. The trait is similar tofutures::Executorbut with an error type matchingExecutor.While the trait is similar enough to the one in
futures, Tokio will offer long term support for it (vs, the one in futures-rs going away).This trait is the basis for implementing components that require spawning and wish to be generic over executors that supports
Sendfutures vs. ones that do not. See here.Remaining
Closes #625