OpenSource/axum
OpenSource/axum
1
0
Fork 0
mirror of https://github.com/tokio-rs/axum.git synced 2024-11-22 23:30:29 +01:00
Code Issues Projects Releases Packages Wiki Activity

Replace weird doc paragraph by compiler-checked must_use attribute (#1801)

Browse source 
Co-authored-by: David Pedersen <david.pdrsn@gmail.com>
This commit is contained in:
Jonas Platte 2023-03-03 09:54:38 +01:00 committed by GitHub
parent 416a0568d3
commit 43883b8d9b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
axum/CHANGELOG.md
View file

@ -7,7 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
# Unreleased # Unreleased
- None. - **fixed:** Add `#[must_use]` to `WebSocketUpgrade::on_upgrade` ([#1801])
[#1801]: https://github.com/tokio-rs/axum/pull/1801
# 0.6.9 (24. February, 2023) # 0.6.9 (24. February, 2023)

5
axum/src/extract/ws.rs
View file

@ -282,10 +282,7 @@ impl<F> WebSocketUpgrade<F> {
/// Finalize upgrading the connection and call the provided callback with /// Finalize upgrading the connection and call the provided callback with
/// the stream. /// the stream.
/// #[must_use = "to setup the WebSocket connection, this response must be returned"]
/// When using `WebSocketUpgrade`, the response produced by this method
/// should be returned from the handler. See the [module docs](self) for an
/// example.
pub fn on_upgrade<C, Fut>(self, callback: C) -> Response pub fn on_upgrade<C, Fut>(self, callback: C) -> Response
where where
C: FnOnce(WebSocket) -> Fut + Send + 'static, C: FnOnce(WebSocket) -> Fut + Send + 'static,