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-01 00:00:14 +02:00 · 2022-08-17 15:13:31 +00:00
parent 90dbd52ee4
commit 423308de3c
132 changed files with 2404 additions and 1126 deletions
@@ -36,7 +36,7 @@ use tower_service::Service;
 ///     .merge(spa)
 ///     // we can still add other routes
 ///     .route("/api/foo", get(api_foo));
-/// # let _: Router<axum::body::Body> = app;
+/// # let _: Router = app;
 ///
 /// async fn api_foo() {}
 /// ```
@@ -101,7 +101,7 @@ impl<B, T, F> SpaRouter<B, T, F> {
    ///     .index_file("another_file.html");
    ///
    /// let app = Router::new().merge(spa);
-    /// # let _: Router<axum::body::Body> = app;
+    /// # let _: Router = app;
    /// ```
    pub fn index_file<P>(mut self, path: P) -> Self
    where
@@ -136,7 +136,7 @@ impl<B, T, F> SpaRouter<B, T, F> {
    /// }
    ///
    /// let app = Router::new().merge(spa);
-    /// # let _: Router<axum::body::Body> = app;
+    /// # let _: Router = app;
    /// ```
    pub fn handle_error<T2, F2>(self, f: F2) -> SpaRouter<B, T2, F2> {
        SpaRouter {
@@ -147,7 +147,7 @@ impl<B, T, F> SpaRouter<B, T, F> {
    }
 }

-impl<B, F, T> From<SpaRouter<B, T, F>> for Router<B>
+impl<B, F, T> From<SpaRouter<B, T, F>> for Router<(), B>
 where
    F: Clone + Send + 'static,
    HandleError<Route<B, io::Error>, F, T>: Service<Request<B>, Error = Infallible>,
@@ -162,7 +162,7 @@ where

        Router::new()
            .nest(&spa.paths.assets_path, assets_service)
-            .fallback(
+            .fallback_service(
                get_service(ServeFile::new(&spa.paths.index_file)).handle_error(spa.handle_error),
            )
    }
@@ -264,6 +264,13 @@ mod tests {

        let spa = SpaRouter::new("/assets", "test_files").handle_error(handle_error);

-        Router::<Body>::new().merge(spa);
+        Router::<_, Body>::new().merge(spa);
+    }
+
+    #[allow(dead_code)]
+    fn works_with_router_with_state() {
+        let _: Router<String> = Router::with_state(String::new())
+            .merge(SpaRouter::new("/assets", "test_files"))
+            .route("/", get(|_: axum::extract::State<String>| async {}));
    }
 }