From d87dac66dfbbb2a9d947c0ad82163babf020fabb Mon Sep 17 00:00:00 2001
From: Michael Scofield <mscofield0@tutanota.com>
Date: Fri, 24 Feb 2023 22:35:31 +0100
Subject: [PATCH] Fix typo in extract::ws (#1664)
Co-authored-by: David Pedersen <david.pdrsn@gmail.com>
---
axum/CHANGELOG.md | 3 +++
axum/src/extract/ws.rs | 20 ++++++++++----------
2 files changed, 13 insertions(+), 10 deletions(-)
diff --git a/axum/CHANGELOG.md b/axum/CHANGELOG.md
index 6ef7065f36..4aa76018ff 100644
--- a/axum/CHANGELOG.md
+++ b/axum/CHANGELOG.md
@@ -8,8 +8,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
# Unreleased
- **breaking:** Change `sse::Event::json_data` to use `axum_core::Error` as its error type ([#1762])
+- **breaking:** Rename `DefaultOnFailedUpdgrade` to `DefaultOnFailedUpgrade` ([#1664])
+- **breaking:** Rename `OnFailedUpdgrade` to `OnFailedUpgrade` ([#1664])
[#1762]: https://github.com/tokio-rs/axum/pull/1762
+[#1664]: https://github.com/tokio-rs/axum/pull/1664
# 0.6.10 (03. March, 2023)
diff --git a/axum/src/extract/ws.rs b/axum/src/extract/ws.rs
index 5c1167c4bc..9ed0780f49 100644
--- a/axum/src/extract/ws.rs
+++ b/axum/src/extract/ws.rs
@@ -135,7 +135,7 @@ use tokio_tungstenite::{
///
/// See the [module docs](self) for an example.
#[cfg_attr(docsrs, doc(cfg(feature = "ws")))]
-pub struct WebSocketUpgrade<F = DefaultOnFailedUpdgrade> {
+pub struct WebSocketUpgrade<F = DefaultOnFailedUpgrade> {
config: WebSocketConfig,
/// The chosen protocol sent in the `Sec-WebSocket-Protocol` header of the response.
protocol: Option<HeaderValue>,
@@ -268,7 +268,7 @@ impl<F> WebSocketUpgrade<F> {
/// ```
pub fn on_failed_upgrade<C>(self, callback: C) -> WebSocketUpgrade<C>
where
- C: OnFailedUpdgrade,
+ C: OnFailedUpgrade,
{
WebSocketUpgrade {
config: self.config,
@@ -287,7 +287,7 @@ impl<F> WebSocketUpgrade<F> {
where
C: FnOnce(WebSocket) -> Fut + Send + 'static,
Fut: Future<Output = ()> + Send + 'static,
- F: OnFailedUpdgrade,
+ F: OnFailedUpgrade,
{
let on_upgrade = self.on_upgrade;
let config = self.config;
@@ -339,12 +339,12 @@ impl<F> WebSocketUpgrade<F> {
/// What to do when a connection upgrade fails.
///
/// See [`WebSocketUpgrade::on_failed_upgrade`] for more details.
-pub trait OnFailedUpdgrade: Send + 'static {
+pub trait OnFailedUpgrade: Send + 'static {
/// Call the callback.
fn call(self, error: Error);
}
-impl<F> OnFailedUpdgrade for F
+impl<F> OnFailedUpgrade for F
where
F: FnOnce(Error) + Send + 'static,
{
@@ -353,20 +353,20 @@ where
}
}
-/// The default `OnFailedUpdgrade` used by `WebSocketUpgrade`.
+/// The default `OnFailedUpgrade` used by `WebSocketUpgrade`.
///
/// It simply ignores the error.
#[non_exhaustive]
#[derive(Debug)]
-pub struct DefaultOnFailedUpdgrade;
+pub struct DefaultOnFailedUpgrade;
-impl OnFailedUpdgrade for DefaultOnFailedUpdgrade {
+impl OnFailedUpgrade for DefaultOnFailedUpgrade {
#[inline]
fn call(self, _error: Error) {}
}
#[async_trait]
-impl<S> FromRequestParts<S> for WebSocketUpgrade<DefaultOnFailedUpdgrade>
+impl<S> FromRequestParts<S> for WebSocketUpgrade<DefaultOnFailedUpgrade>
where
S: Send + Sync,
{
@@ -407,7 +407,7 @@ where
sec_websocket_key,
on_upgrade,
sec_websocket_protocol,
- on_failed_upgrade: DefaultOnFailedUpdgrade,
+ on_failed_upgrade: DefaultOnFailedUpgrade,
})
}
}