Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tokio: prepare to release v1.18.0 #4641

Merged
merged 2 commits into from Apr 27, 2022
Merged

tokio: prepare to release v1.18.0 #4641

merged 2 commits into from Apr 27, 2022

Conversation

hawkw
Copy link
Member

@hawkw hawkw commented Apr 27, 2022

1.18.0 (April 27, 2022)

This release adds a number of new APIs in tokio::net, tokio::signal, and
tokio::sync. In addition, it adds new unstable APIs to tokio::task (Ids
for uniquely identifying a task, and AbortHandle for remotely cancelling a
task), as well as a number of bugfixes.

Fixed

  • blocking: add missing #[track_caller] for spawn_blocking (#4616)
  • macros: fix select macro to process 64 branches (#4519)
  • net: fix try_io methods not calling Mio's try_io internally (#4582)
  • runtime: recover when OS fails to spawn a new thread (#4485)

Added

  • macros: support setting a custom crate name for #[tokio::main] and
    #[tokio::test] (#4613)
  • net: add UdpSocket::peer_addr (#4611)
  • net: add try_read_buf method for named pipes (#4626)
  • signal: add SignalKind Hash/Eq impls and c_int conversion (#4540)
  • signal: add support for signals up to SIGRTMAX (#4555)
  • sync: add watch::Sender::send_modify method (#4310)
  • sync: add broadcast::Receiver::len method (#4542)
  • sync: add watch::Receiver::same_channel method (#4581)
  • sync: implement Clone for RecvError types (#4560)

Changed

  • update mio to 0.8.1 (#4582)
  • macros: rename tokio::select!'s internal util module (#4543)
  • runtime: use Vec::with_capacity when building runtime (#4553)

Documented

  • improve docs for tokio_unstable (#4524)
  • runtime: include more documentation for thread_pool/worker (#4511)
  • runtime: update Handle::current's docs to mention EnterGuard (#4567)
  • time: clarify platform specific timer resolution (#4474)
  • signal: document that Signal::recv is cancel-safe (#4634)
  • sync: UnboundedReceiver close docs (#4548)

Unstable

The following changes only apply when building with --cfg tokio_unstable:

  • task: add task::Id type (#4630)
  • task: add AbortHandle type for cancelling tasks in a JoinSet (#4530,
    #4640)
  • task: fix missing doc(cfg(...)) attributes for JoinSet (#4531)
  • task: fix broken link in AbortHandle RustDoc (#4545)
  • metrics: add initial IO driver metrics (#4507)

# 1.18.0 (April 27, 2022)

This release adds a number of new APIs in `tokio::net`, `tokio::signal`, and
`tokio::sync`. In addition, it adds new unstable APIs to `tokio::task` (`Id`s
for uniquely identifying a task, and `AbortHandle` for remotely cancelling a
task), as well as a number of bugfixes.

### Fixed

- blocking: add missing `#[track_caller]` for `spawn_blocking` ([#4616])
- macros: fix `select` macro to process 64 branches ([#4519])
- net: fix `try_io` methods not calling Mio's `try_io` internally ([#4582])
- runtime: recover when OS fails to spawn a new thread ([#4485])

### Added

- macros: support setting a custom crate name for `#[tokio::main]` and
  `#[tokio::test]` ([#4613])
- net: add `UdpSocket::peer_addr` ([#4611])
- net: add `try_read_buf` method for named pipes ([#4626])
- signal: add `SignalKind` `Hash`/`Eq` impls and `c_int` conversion ([#4540])
- signal: add support for signals up to `SIGRTMAX` ([#4555])
- sync: add `watch::Sender::send_modify` method ([#4310])
- sync: add `broadcast::Receiver::len` method ([#4542])
- sync: add `watch::Receiver::same_channel` method ([#4581])
- sync: implement `Clone` for `RecvError` types ([#4560])

### Changed

- update `nix` to 0.24, limit features ([#4631])
- update `mio` to 0.8.1 ([#4582])
- macros: rename `tokio::select!`'s internal `util` module ([#4543])
- runtime: use `Vec::with_capacity` when building runtime ([#4553])

### Documented

- improve docs for `tokio_unstable` ([#4524])
- runtime: include more documentation for thread_pool/worker ([#4511])
- runtime: update `Handle::current`'s docs to mention `EnterGuard` ([#4567])
- time: clarify platform specific timer resolution ([#4474])
- signal: document that `Signal::recv` is cancel-safe ([#4634])
- sync: `UnboundedReceiver` close docs ([#4548])

### Unstable

The following changes only apply when building with `--cfg tokio_unstable`:

- task: add `task::Id` type ([#4630])
- task: add `AbortHandle` type for cancelling tasks in a `JoinSet` ([#4530],
  [#4640])
- task: fix missing `doc(cfg(...))` attributes for `JoinSet` ([#4531])
- task: fix broken link in `AbortHandle` RustDoc ([#4545])
- metrics: add initial IO driver metrics ([#4507])

[#4616]: #4616
[#4519]: #4519
[#4582]: #4582
[#4485]: #4485
[#4613]: #4613
[#4611]: #4611
[#4626]: #4626
[#4540]: #4540
[#4555]: #4555
[#4310]: #4310
[#4542]: #4542
[#4581]: #4581
[#4560]: #4560
[#4631]: #4631
[#4582]: #4582
[#4543]: #4543
[#4553]: #4553
[#4524]: #4524
[#4511]: #4511
[#4567]: #4567
[#4474]: #4474
[#4634]: #4634
[#4548]: #4548
[#4630]: #4630
[#4530]: #4530
[#4640]: #4640
[#4531]: #4531
[#4545]: #4545
[#4507]: #4507
@hawkw
Copy link
Member Author

hawkw commented Apr 27, 2022

Note that this PR doesn't update the version in the READMEs or in Tokio's Cargo.toml; that's because PR #4640 already bumped them in order to indicate that tokio-util depended on unreleased changes.

@hawkw hawkw requested a review from a team April 27, 2022 16:40
@hawkw hawkw self-assigned this Apr 27, 2022
@Darksonn Darksonn added the A-tokio Area: The main tokio crate label Apr 27, 2022
Copy link
Member

@carllerche carllerche left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!


### Changed

- update `nix` to 0.24, limit features ([#4631])
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a dev-dependency, so it shouldn't be listed in the changelog.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, will remove it, thanks!

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
@hawkw hawkw enabled auto-merge (squash) April 27, 2022 16:48
@hawkw hawkw merged commit 4818343 into master Apr 27, 2022
@hawkw hawkw deleted the eliza/1.18.0 branch April 27, 2022 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants