Add type safe state extractor (#1155)

* begin threading the state through * Pass state to extractors * make state extractor work * make sure nesting with different states work * impl Service for MethodRouter<()> * Fix some of axum-macro's tests * Implement more traits for `State` * Update examples to use `State` * consistent naming of request body param * swap type params * Default the state param to () * fix docs references * Docs and handler state refactoring * docs clean ups * more consistent naming * when does MethodRouter implement Service? * add missing docs * use `Router`'s default state type param * changelog * don't use default type param for FromRequest and RequestParts probably safer for library authors so you don't accidentally forget * fix examples * minor docs tweaks * clarify how to convert handlers into services * group methods in one impl block * make sure merged `MethodRouter`s can access state * fix docs link * test merge with same state type * Document how to access state from middleware * Port cookie extractors to use state to extract keys (#1250) * Updates ECOSYSTEM with a new sample project (#1252) * Avoid unhelpful compiler suggestion (#1251) * fix docs typo * document how library authors should access state * Add `RequestParts::with_state` * fix example * apply suggestions from review * add relevant changes to axum-extra and axum-core changelogs * Add `route_service_with_tsr` * fix trybuild expectations * make sure `SpaRouter` works with routers that have state * Change order of type params on FromRequest and RequestParts * reverse order of `RequestParts::with_state` args to match type params * Add `FromRef` trait (#1268) * Add `FromRef` trait * Remove unnecessary type params * format * fix docs link * format examples * Avoid unnecessary `MethodRouter` * apply suggestions from review Co-authored-by: Dani Pardo <[email protected]> Co-authored-by: Jonas Platte <[email protected]>
2026-09-06 00:00:17 +02:00 · 2022-08-17 15:13:31 +00:00
parent 90dbd52ee4
commit 423308de3c
132 changed files with 2404 additions and 1126 deletions
@@ -15,7 +15,7 @@ struct Extractor {

 fn assert_from_request()
 where
-    Extractor: FromRequest<Body, Rejection = JsonRejection>,
+    Extractor: FromRequest<(), Body, Rejection = JsonRejection>,
 {
 }

@@ -14,13 +14,14 @@ struct Extractor {
 struct OtherExtractor;

 #[async_trait]
-impl<B> FromRequest<B> for OtherExtractor
+impl<S, B> FromRequest<S, B> for OtherExtractor
 where
-    B: Send + 'static,
+    B: Send,
+    S: Send,
 {
    type Rejection = OtherExtractorRejection;

-    async fn from_request(_req: &mut RequestParts<B>) -> Result<Self, Self::Rejection> {
+    async fn from_request(_req: &mut RequestParts<S, B>) -> Result<Self, Self::Rejection> {
        unimplemented!()
    }
 }
@@ -5,7 +5,7 @@ struct Extractor {}

 fn assert_from_request()
 where
-    Extractor: axum::extract::FromRequest<axum::body::Body, Rejection = std::convert::Infallible>,
+    Extractor: axum::extract::FromRequest<(), axum::body::Body, Rejection = std::convert::Infallible>,
 {
 }

@@ -5,7 +5,7 @@ struct Extractor();

 fn assert_from_request()
 where
-    Extractor: axum::extract::FromRequest<axum::body::Body, Rejection = std::convert::Infallible>,
+    Extractor: axum::extract::FromRequest<(), axum::body::Body, Rejection = std::convert::Infallible>,
 {
 }

@@ -8,5 +8,5 @@ enum Extractor {}
 async fn foo(_: Extractor) {}

 fn main() {
-    Router::<Body>::new().route("/", get(foo));
+    Router::<(), Body>::new().route("/", get(foo));
 }
@@ -18,7 +18,7 @@ struct Extractor {

 fn assert_from_request()
 where
-    Extractor: FromRequest<Body, Rejection = ExtractorRejection>,
+    Extractor: FromRequest<(), Body, Rejection = ExtractorRejection>,
 {
 }

@@ -25,7 +25,7 @@ struct Extractor {

 fn assert_from_request()
 where
-    Extractor: FromRequest<Body, Rejection = ExtractorRejection>,
+    Extractor: FromRequest<(), Body, Rejection = ExtractorRejection>,
 {
 }

@@ -28,14 +28,15 @@ struct MyExtractor {
 struct OtherExtractor;

 #[async_trait]
-impl<B> FromRequest<B> for OtherExtractor
+impl<S, B> FromRequest<S, B> for OtherExtractor
 where
    B: Send + 'static,
+    S: Send,
 {
    // this rejection doesn't implement `Display` and `Error`
    type Rejection = (StatusCode, String);

-    async fn from_request(_req: &mut RequestParts<B>) -> Result<Self, Self::Rejection> {
+    async fn from_request(_req: &mut RequestParts<S, B>) -> Result<Self, Self::Rejection> {
        todo!()
    }
 }
@@ -5,7 +5,7 @@ struct Extractor(axum::http::HeaderMap, String);

 fn assert_from_request()
 where
-    Extractor: axum::extract::FromRequest<axum::body::Body>,
+    Extractor: axum::extract::FromRequest<(), axum::body::Body>,
 {
 }

@@ -13,7 +13,7 @@ struct Payload {}

 fn assert_from_request()
 where
-    Extractor: axum::extract::FromRequest<axum::body::Body>,
+    Extractor: axum::extract::FromRequest<(), axum::body::Body>,
 {
 }

@@ -27,7 +27,7 @@ struct Payload {}

 fn assert_from_request()
 where
-    Extractor: axum::extract::FromRequest<axum::body::Body>,
+    Extractor: axum::extract::FromRequest<(), axum::body::Body>,
 {
 }

@@ -1,5 +1,5 @@
+use axum::Extension;
 use axum_macros::FromRequest;
-use axum::extract::Extension;

 #[derive(FromRequest)]
 struct Extractor(#[from_request(via(Extension))] State);
@@ -9,7 +9,7 @@ struct State;

 fn assert_from_request()
 where
-    Extractor: axum::extract::FromRequest<axum::body::Body>,
+    Extractor: axum::extract::FromRequest<(), axum::body::Body>,
 {
 }

@@ -5,7 +5,7 @@ struct Extractor;

 fn assert_from_request()
 where
-    Extractor: axum::extract::FromRequest<axum::body::Body, Rejection = std::convert::Infallible>,
+    Extractor: axum::extract::FromRequest<(), axum::body::Body, Rejection = std::convert::Infallible>,
 {
 }