tokio-current-thread crate #370
Conversation
|
Thanks so much for taking a stab at this. Sorry for the delay, I have been away from a computer. I will be reviewing this shortly. |
src/executor/mod.rs
Outdated
| //! [`CurrentThread`]: struct.CurrentThread.html | ||
| //! [`Future::poll`]: https://docs.rs/futures/0.1/futures/future/trait.Future.html#tymethod.poll | ||
|
|
||
| pub use tokio_current_thread::{ |
There was a problem hiding this comment.
It looks like there are some re-exports missing (https://docs.rs/tokio/0.1.6/tokio/executor/current_thread/index.html)
BlockErrorRunTimeoutErrorTurnTurnErrorspawn
There was a problem hiding this comment.
Ok, I've added re-exports for all missing public struct and fn which are not deprecated.
There was a problem hiding this comment.
Actually, that is a good point.
The deprecated APIs have to stay in tokio::executor::current_thread, but they don't actually have to move to the new crate. This is to maintain backwards compatibility.
Is it possible to do that? (keep them in the old location w/o introducing them in thew new ones).
There was a problem hiding this comment.
You're right it must stay in the old location to no break code which still use the deprecated API. I will take a look on it at the end of the week, and will then update the PR.
Thanks for the review !
tokio-current-thread/Cargo.toml
Outdated
| # - Update html_root_url. | ||
| # - Update CHANGELOG.md. | ||
| # - Create "v0.1.x" git tag. | ||
| version = "0.1.6" |
There was a problem hiding this comment.
This should be "0.1.0" since it is the first release.
There was a problem hiding this comment.
I've changed the crate to the 0.1.0 version and I've also adjusted deprecated annotations which were pointing on the non existing 0.1.2 version.
tokio-current-thread/src/lib.rs
Outdated
| //! [`Future::poll`]: https://docs.rs/futures/0.1/futures/future/trait.Future.html#tymethod.poll | ||
| //! [executor module]: https://docs.rs/tokio/0.1/tokio/executor/index.html | ||
|
|
||
| #![doc(html_root_url = "https://docs.rs/tokio-current-thread/0.1.6")] |
src/executor/mod.rs
Outdated
| //! [`CurrentThread`]: struct.CurrentThread.html | ||
| //! [`Future::poll`]: https://docs.rs/futures/0.1/futures/future/trait.Future.html#tymethod.poll | ||
|
|
||
| pub use tokio_current_thread::{ |
There was a problem hiding this comment.
Actually, that is a good point.
The deprecated APIs have to stay in tokio::executor::current_thread, but they don't actually have to move to the new crate. This is to maintain backwards compatibility.
Is it possible to do that? (keep them in the old location w/o introducing them in thew new ones).
Add back the current_thread module in the executor, deprecated functions and structs which are defined here relies on the new tokio-current-thread crate.
jpbriquet
force-pushed
the
tokio-current-thread-crate
branch
from
c7591b5
to
2f218a8
Compare
|
@carllerche As promised, I have adjusted the PR to be backward compatible. I have not found any tests related to the deprecated API, so, just to be sure, I've checked that I could call this API on my side. The code has also been rebased, thus latest current_thread changes ("Handle" struct) is now integrated. As always let me know if I need to change something. |
Hello Tokio team,
Here is a pull request for the issue (#356) :
Extract
tokio::executor::current_threadto a tokio-current-thread crateI was not sure if the crate documentation should be located in the tokio executor module (like the thread-pool one), or directly in the tokio-current-thread crate.
So, I've done the same than for the threadpool, the tokio-current-thread crate documentation is only a summary, and the full detailed documentation is located in the executor module.
It is my first contribution and also my first work on a rust project, so let me know if I need to do some changes.