Tags: Ka1wa/axum
Tags
Version 0.2.5 (tokio-rs#336) - Add accessors for `TypedHeaderRejection` fields ([tokio-rs#317]) - Improve docs for extractors ([tokio-rs#327]) [tokio-rs#317]: tokio-rs#317 [tokio-rs#327]: tokio-rs#327
Version 0.2.4 (tokio-rs#313) Contains some documentation improvements: - Document using `StreamExt::split` with `WebSocket` ([tokio-rs#291]) - Document adding middleware to multiple groups of routes ([tokio-rs#293]) [tokio-rs#291]: tokio-rs#291 [tokio-rs#293]: tokio-rs#293
Version 0.2.3 (tokio-rs#274) 0.2.3 (26. August, 2021) - **fixed:** Fix accidental breaking change introduced by internal refactor. `BoxRoute` used to be `Sync` but was accidental made `!Sync` ([tokio-rs#273](tokio-rs#273))
Version 0.2.2 (tokio-rs#271) 0.2.2 (24. August, 2021) - **fixed:** Fix URI captures matching empty segments. This means requests with URI `/` will no longer be matched by `/:key` ([tokio-rs#264](tokio-rs#264)) - **fixed:** Remove needless trait bounds from `Router::boxed` ([tokio-rs#264](tokio-rs#264))
Version 0.2.1 (tokio-rs#256) 0.2.1 (24. August, 2021) - **added:** Add `Redirect::to` constructor ([tokio-rs#255](tokio-rs#255)) - **added:** Document how to implement `IntoResponse` for custom error type ([tokio-rs#258](tokio-rs#258))
Version 0.2.0 (tokio-rs#247) - Overall: - **fixed:** Overall compile time improvements. If you're having issues with compile time please file an issue! ([tokio-rs#184](tokio-rs#184)) ([tokio-rs#198](tokio-rs#198)) ([tokio-rs#220](tokio-rs#220)) - **changed:** Remove `prelude`. Explicit imports are now required ([tokio-rs#195](tokio-rs#195)) - Routing: - **added:** Add dedicated `Router` to replace the `RoutingDsl` trait ([tokio-rs#214](tokio-rs#214)) - **added:** Add `Router::or` for combining routes ([tokio-rs#108](tokio-rs#108)) - **fixed:** Support matching different HTTP methods for the same route that aren't defined together. So `Router::new().route("/", get(...)).route("/", post(...))` now accepts both `GET` and `POST`. Previously only `POST` would be accepted ([tokio-rs#224](tokio-rs#224)) - **fixed:** `get` routes will now also be called for `HEAD` requests but will always have the response body removed ([tokio-rs#129](tokio-rs#129)) - **changed:** Replace `axum::route(...)` with `axum::Router::new().route(...)`. This means there is now only one way to create a new router. Same goes for `axum::routing::nest`. ([tokio-rs#215](tokio-rs#215)) - **changed:** Implement `routing::MethodFilter` via [`bitflags`](https://crates.io/crates/bitflags) ([tokio-rs#158](tokio-rs#158)) - **changed:** Move `handle_error` from `ServiceExt` to `service::OnMethod` ([tokio-rs#160](tokio-rs#160)) With these changes this app using 0.1: ```rust use axum::{extract::Extension, prelude::*, routing::BoxRoute, AddExtensionLayer}; let app = route("/", get(|| async { "hi" })) .nest("/api", api_routes()) .layer(AddExtensionLayer::new(state)); fn api_routes() -> BoxRoute<Body> { route( "/users", post(|Extension(state): Extension<State>| async { "hi from nested" }), ) .boxed() } ``` Becomes this in 0.2: ```rust use axum::{ extract::Extension, handler::{get, post}, routing::BoxRoute, Router, }; let app = Router::new() .route("/", get(|| async { "hi" })) .nest("/api", api_routes()); fn api_routes() -> Router<BoxRoute> { Router::new() .route( "/users", post(|Extension(state): Extension<State>| async { "hi from nested" }), ) .boxed() } ``` - Extractors: - **added:** Make `FromRequest` default to being generic over `body::Body` ([tokio-rs#146](tokio-rs#146)) - **added:** Implement `std::error::Error` for all rejections ([tokio-rs#153](tokio-rs#153)) - **added:** Add `OriginalUri` for extracting original request URI in nested services ([tokio-rs#197](tokio-rs#197)) - **added:** Implement `FromRequest` for `http::Extensions` ([tokio-rs#169](tokio-rs#169)) - **added:** Make `RequestParts::{new, try_into_request}` public so extractors can be used outside axum ([tokio-rs#194](tokio-rs#194)) - **added:** Implement `FromRequest` for `axum::body::Body` ([tokio-rs#241](tokio-rs#241)) - **changed:** Removed `extract::UrlParams` and `extract::UrlParamsMap`. Use `extract::Path` instead ([tokio-rs#154](tokio-rs#154)) - **changed:** `extractor_middleware` now requires `RequestBody: Default` ([tokio-rs#167](tokio-rs#167)) - **changed:** Convert `RequestAlreadyExtracted` to an enum with each possible error variant ([tokio-rs#167](tokio-rs#167)) - **changed:** `extract::BodyStream` is no longer generic over the request body ([tokio-rs#234](tokio-rs#234)) - **changed:** `extract::Body` has been renamed to `extract::RawBody` to avoid conflicting with `body::Body` ([tokio-rs#233](tokio-rs#233)) - **changed:** `RequestParts` changes ([tokio-rs#153](tokio-rs#153)) - `method` new returns an `&http::Method` - `method_mut` new returns an `&mut http::Method` - `take_method` has been removed - `uri` new returns an `&http::Uri` - `uri_mut` new returns an `&mut http::Uri` - `take_uri` has been removed - **changed:** Remove several rejection types that were no longer used ([tokio-rs#153](tokio-rs#153)) ([tokio-rs#154](tokio-rs#154)) - Responses: - **added:** Add `Headers` for easily customizing headers on a response ([tokio-rs#193](tokio-rs#193)) - **added:** Add `Redirect` response ([tokio-rs#192](tokio-rs#192)) - **added:** Add `body::StreamBody` for easily responding with a stream of byte chunks ([tokio-rs#237](tokio-rs#237)) - **changed:** Add associated `Body` and `BodyError` types to `IntoResponse`. This is required for returning responses with bodies other than `hyper::Body` from handlers. See the docs for advice on how to implement `IntoResponse` ([tokio-rs#86](tokio-rs#86)) - **changed:** `tower::util::Either` no longer implements `IntoResponse` ([tokio-rs#229](tokio-rs#229)) This `IntoResponse` from 0.1: ```rust use axum::{http::Response, prelude::*, response::IntoResponse}; struct MyResponse; impl IntoResponse for MyResponse { fn into_response(self) -> Response<Body> { Response::new(Body::empty()) } } ``` Becomes this in 0.2: ```rust use axum::{body::Body, http::Response, response::IntoResponse}; struct MyResponse; impl IntoResponse for MyResponse { type Body = Body; type BodyError = <Self::Body as axum::body::HttpBody>::Error; fn into_response(self) -> Response<Self::Body> { Response::new(Body::empty()) } } ``` - SSE: - **added:** Add `response::sse::Sse`. This implements SSE using a response rather than a service ([tokio-rs#98](tokio-rs#98)) - **changed:** Remove `axum::sse`. Its been replaced by `axum::response::sse` ([tokio-rs#98](tokio-rs#98)) Handler using SSE in 0.1: ```rust use axum::{ prelude::*, sse::{sse, Event}, }; use std::convert::Infallible; let app = route( "/", sse(|| async { let stream = futures::stream::iter(vec![Ok::<_, Infallible>( Event::default().data("hi there!"), )]); Ok::<_, Infallible>(stream) }), ); ``` Becomes this in 0.2: ```rust use axum::{ handler::get, response::sse::{Event, Sse}, Router, }; use std::convert::Infallible; let app = Router::new().route( "/", get(|| async { let stream = futures::stream::iter(vec![Ok::<_, Infallible>( Event::default().data("hi there!"), )]); Sse::new(stream) }), ); ``` - WebSockets: - **changed:** Change WebSocket API to use an extractor plus a response ([tokio-rs#121](tokio-rs#121)) - **changed:** Make WebSocket `Message` an enum ([tokio-rs#116](tokio-rs#116)) - **changed:** `WebSocket` now uses `Error` as its error type ([tokio-rs#150](tokio-rs#150)) Handler using WebSockets in 0.1: ```rust use axum::{ prelude::*, ws::{ws, WebSocket}, }; let app = route( "/", ws(|socket: WebSocket| async move { // do stuff with socket }), ); ``` Becomes this in 0.2: ```rust use axum::{ extract::ws::{WebSocket, WebSocketUpgrade}, handler::get, Router, }; let app = Router::new().route( "/", get(|ws: WebSocketUpgrade| async move { ws.on_upgrade(|socket: WebSocket| async move { // do stuff with socket }) }), ); ``` - Misc - **added:** Add default feature `tower-log` which exposes `tower`'s `log` feature. ([tokio-rs#218](tokio-rs#218)) - **changed:** Replace `body::BoxStdError` with `axum::Error`, which supports downcasting ([tokio-rs#150](tokio-rs#150)) - **changed:** `EmptyRouter` now requires the response body to implement `Send + Sync + 'static'` ([tokio-rs#108](tokio-rs#108)) - **changed:** `Router::check_infallible` now returns a `CheckInfallible` service. This is to improve compile times ([tokio-rs#198](tokio-rs#198)) - **changed:** `Router::into_make_service` now returns `routing::IntoMakeService` rather than `tower::make::Shared` ([tokio-rs#229](tokio-rs#229)) - **changed:** All usage of `tower::BoxError` has been replaced with `axum::BoxError` ([tokio-rs#229](tokio-rs#229)) - **changed:** Several response future types have been moved into dedicated `future` modules ([tokio-rs#133](tokio-rs#133)) - **changed:** `EmptyRouter`, `ExtractorMiddleware`, `ExtractorMiddlewareLayer`, and `QueryStringMissing` no longer implement `Copy` ([tokio-rs#132](tokio-rs#132)) - **changed:** `service::OnMethod`, `handler::OnMethod`, and `routing::Nested` have new response future types ([tokio-rs#157](tokio-rs#157))
Version 0.1.3 (tokio-rs#139) - Fix stripping prefix when nesting services at `/` ([tokio-rs#91](tokio-rs#91)) - Add support for WebSocket protocol negotiation ([tokio-rs#83](tokio-rs#83)) - Use `pin-project-lite` instead of `pin-project` ([tokio-rs#95](tokio-rs#95)) - Re-export `http` crate and `hyper::Server` ([tokio-rs#110](tokio-rs#110)) - Fix `Query` and `Form` extractors giving bad request error when query string is empty. ([tokio-rs#117](tokio-rs#117)) - Add `Path` extractor. ([tokio-rs#124](tokio-rs#124)) - Fixed the implementation of `IntoResponse` of `(HeaderMap, T)` and `(StatusCode, HeaderMap, T)` would ignore headers from `T` ([tokio-rs#137](tokio-rs#137)) - Deprecate `extract::UrlParams` and `extract::UrlParamsMap`. Use `extract::Path` instead ([tokio-rs#138](tokio-rs#138))