Remove OptionalFromRequestParts impl for Query

Author: jplatte

axum-extra/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning].
 
 # Unreleased
 
+- **breaking:** Remove `OptionalFromRequestParts` impl for `Query` ([#3088])
+
+[#3088]: https://github.com/tokio-rs/axum/pull/3088
+
 # 0.10.0
 
 ## rc.1

axum-extra/src/extract/query.rs

@@ -1,5 +1,5 @@
 use axum::{
-    extract::{FromRequestParts, OptionalFromRequestParts},
+    extract::FromRequestParts,
     response::{IntoResponse, Response},
     Error,
 };
@@ -18,19 +18,6 @@ use std::fmt;
 /// with the `multiple` attribute. Those values can be collected into a `Vec` or other sequential
 /// container.
 ///
-/// # `Option<Query<T>>` behavior
-///
-/// If `Query<T>` itself is used as an extractor and there is no query string in
-/// the request URL, `T`'s `Deserialize` implementation is called on an empty
-/// string instead.
-///
-/// You can avoid this by using `Option<Query<T>>`, which gives you `None` in
-/// the case that there is no query string in the request URL.
-///
-/// Note that an empty query string is not the same as no query string, that is
-/// `https://example.org/` and `https://example.org/?` are not treated the same
-/// in this case.
-///
 /// # Example
 ///
 /// ```rust,no_run
@@ -109,27 +96,6 @@ where
     }
 }
 
-impl<T, S> OptionalFromRequestParts<S> for Query<T>
-where
-    T: DeserializeOwned,
-    S: Send + Sync,
-{
-    type Rejection = QueryRejection;
-
-    async fn from_request_parts(
-        parts: &mut Parts,
-        _state: &S,
-    ) -> Result<Option<Self>, Self::Rejection> {
-        if let Some(query) = parts.uri.query() {
-            let value = serde_html_form::from_str(query)
-                .map_err(|err| QueryRejection::FailedToDeserializeQueryString(Error::new(err)))?;
-            Ok(Some(Self(value)))
-        } else {
-            Ok(None)
-        }
-    }
-}
-
 axum_core::__impl_deref!(Query);
 
 /// Rejection used for [`Query`].

axum/CHANGELOG.md

@@ -9,9 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - **breaking:** `axum::extract::ws::Message` now uses `Bytes` in place of `Vec<u8>`,
   and a new `Utf8Bytes` type in place of `String`, for its variants ([#3078])
+- **breaking:** Remove `OptionalFromRequestParts` impl for `Query` ([#3088])
 - **changed:** Upgraded `tokio-tungstenite` to 0.26 ([#3078])
 
 [#3078]: https://github.com/tokio-rs/axum/pull/3078
+[#3088]: https://github.com/tokio-rs/axum/pull/3088
 
 # 0.8.0
 

axum/src/docs/extract.md

@@ -108,18 +108,10 @@ struct Pagination {
     per_page: usize,
 }
 
-impl Default for Pagination {
-    fn default() -> Self {
-        Self { page: 1, per_page: 30 }
-    }
-}
-
 async fn get_user_things(
     Path(user_id): Path<Uuid>,
-    pagination: Option<Query<Pagination>>,
+    Query(pagination): Query<Pagination>,
 ) {
-    let Query(pagination) = pagination.unwrap_or_default();
-
     // ...
 }
 # let _: Router = app;

axum/src/extract/query.rs

@@ -1,24 +1,11 @@
-use super::{rejection::*, FromRequestParts, OptionalFromRequestParts};
+use super::{rejection::*, FromRequestParts};
 use http::{request::Parts, Uri};
 use serde::de::DeserializeOwned;
 
 /// Extractor that deserializes query strings into some type.
 ///
 /// `T` is expected to implement [`serde::Deserialize`].
 ///
-/// # `Option<Query<T>>` behavior
-///
-/// If `Query<T>` itself is used as an extractor and there is no query string in
-/// the request URL, `T`'s `Deserialize` implementation is called on an empty
-/// string instead.
-///
-/// You can avoid this by using `Option<Query<T>>`, which gives you `None` in
-/// the case that there is no query string in the request URL.
-///
-/// Note that an empty query string is not the same as no query string, that is
-/// `https://example.org/` and `https://example.org/?` are not treated the same
-/// in this case.
-///
 /// # Examples
 ///
 /// ```rust,no_run
@@ -75,27 +62,6 @@ where
     }
 }
 
-impl<T, S> OptionalFromRequestParts<S> for Query<T>
-where
-    T: DeserializeOwned,
-    S: Send + Sync,
-{
-    type Rejection = QueryRejection;
-
-    async fn from_request_parts(
-        parts: &mut Parts,
-        _state: &S,
-    ) -> Result<Option<Self>, Self::Rejection> {
-        if let Some(query) = parts.uri.query() {
-            let value = serde_urlencoded::from_str(query)
-                .map_err(FailedToDeserializeQueryString::from_err)?;
-            Ok(Some(Self(value)))
-        } else {
-            Ok(None)
-        }
-    }
-}
-
 impl<T> Query<T>
 where
     T: DeserializeOwned,