2021-06-12 20:18:21 +02:00
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog ](https://keepachangelog.com/en/1.0.0/ ),
and this project adheres to [Semantic Versioning ](https://semver.org/spec/v2.0.0.html ).
# Unreleased
2021-08-07 23:05:53 +02:00
- Make `FromRequest` default to being generic over `body::Body` ([#146](https://github.com/tokio-rs/axum/pull/146))
2021-08-07 21:03:04 +02:00
- Implement `std::error::Error` for all rejections ([#153](https://github.com/tokio-rs/axum/pull/153))
2021-08-07 22:35:41 +02:00
- Add `RoutingDsl::or` for combining routes ([#108](https://github.com/tokio-rs/axum/pull/108))
Move methods from `ServiceExt` to `RoutingDsl` (#160)
Previously, on `main`, this wouldn't compile:
```rust
let app = route("/", get(handler))
.layer(
ServiceBuilder::new()
.timeout(Duration::from_secs(10))
.into_inner(),
)
.handle_error(...)
.route(...); // <-- doesn't work
```
That is because `handle_error` would be
`axum::service::ServiceExt::handle_error` which returns `HandleError<_,
_, _, HandleErrorFromService>` which does _not_ implement `RoutingDsl`.
So you couldn't call `route`. This was caused by
https://github.com/tokio-rs/axum/pull/120.
Basically `handle_error` when called on a `RoutingDsl`, the resulting
service should also implement `RoutingDsl`, but if called on another
random service it should _not_ implement `RoutingDsl`.
I don't think thats possible by having `handle_error` on `ServiceExt`
which is implemented for any service, since all axum routers are also
services by design.
This resolves the issue by removing `ServiceExt` and moving its methods
to `RoutingDsl`. Then we have more tight control over what has a
`handle_error` method.
`service::OnMethod` now also has a `handle_error` so you can still
handle errors from random services, by doing
`service::any(svc).handle_error(...)`.
2021-08-08 14:30:51 +02:00
- Add `handle_error` to `service::OnMethod` ([#160](https://github.com/tokio-rs/axum/pull/160))
2021-08-08 14:45:31 +02:00
- Add `NestedUri` for extracting request URI in nested services ([#161](https://github.com/tokio-rs/axum/pull/161))
2021-08-08 20:01:06 +02:00
- Implement `FromRequest` for `http::Extensions`
2021-08-06 11:20:42 +02:00
## Breaking changes
2021-08-07 18:03:21 +02:00
- 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` ([#86](https://github.com/tokio-rs/axum/pull/86))
2021-08-07 23:05:53 +02:00
- Replace `body::BoxStdError` with `Error` , which supports downcasting ([#150](https://github.com/tokio-rs/axum/pull/150))
2021-08-07 17:26:23 +02:00
- Change WebSocket API to use an extractor ([#121](https://github.com/tokio-rs/axum/pull/121))
2021-08-07 20:24:13 +02:00
- Make WebSocket `Message` an enum ([#116](https://github.com/tokio-rs/axum/pull/116))
2021-08-07 23:05:53 +02:00
- `WebSocket` now uses `Error` as its error type ([#150](https://github.com/tokio-rs/axum/pull/150))
- Ensure a `HandleError` service created from `ServiceExt::handle_error`
2021-08-07 16:44:12 +02:00
_does not_ implement `RoutingDsl` as that could lead to confusing routing
2021-08-07 22:35:41 +02:00
behavior ([#120](https://github.com/tokio-rs/axum/pull/120))
Move methods from `ServiceExt` to `RoutingDsl` (#160)
Previously, on `main`, this wouldn't compile:
```rust
let app = route("/", get(handler))
.layer(
ServiceBuilder::new()
.timeout(Duration::from_secs(10))
.into_inner(),
)
.handle_error(...)
.route(...); // <-- doesn't work
```
That is because `handle_error` would be
`axum::service::ServiceExt::handle_error` which returns `HandleError<_,
_, _, HandleErrorFromService>` which does _not_ implement `RoutingDsl`.
So you couldn't call `route`. This was caused by
https://github.com/tokio-rs/axum/pull/120.
Basically `handle_error` when called on a `RoutingDsl`, the resulting
service should also implement `RoutingDsl`, but if called on another
random service it should _not_ implement `RoutingDsl`.
I don't think thats possible by having `handle_error` on `ServiceExt`
which is implemented for any service, since all axum routers are also
services by design.
This resolves the issue by removing `ServiceExt` and moving its methods
to `RoutingDsl`. Then we have more tight control over what has a
`handle_error` method.
`service::OnMethod` now also has a `handle_error` so you can still
handle errors from random services, by doing
`service::any(svc).handle_error(...)`.
2021-08-08 14:30:51 +02:00
- Fix `Uri` extractor not being the full URI if using `nest` ([#156](https://github.com/tokio-rs/axum/pull/156))
2021-08-07 23:05:53 +02:00
- Implement `routing::MethodFilter` via [`bitflags` ](https://crates.io/crates/bitflags )
2021-08-07 22:35:41 +02:00
- Removed `extract::UrlParams` and `extract::UrlParamsMap` . Use `extract::Path` instead
- `EmptyRouter` now requires the response body to implement `Send + Sync + 'static'` ([#108](https://github.com/tokio-rs/axum/pull/108))
Move methods from `ServiceExt` to `RoutingDsl` (#160)
Previously, on `main`, this wouldn't compile:
```rust
let app = route("/", get(handler))
.layer(
ServiceBuilder::new()
.timeout(Duration::from_secs(10))
.into_inner(),
)
.handle_error(...)
.route(...); // <-- doesn't work
```
That is because `handle_error` would be
`axum::service::ServiceExt::handle_error` which returns `HandleError<_,
_, _, HandleErrorFromService>` which does _not_ implement `RoutingDsl`.
So you couldn't call `route`. This was caused by
https://github.com/tokio-rs/axum/pull/120.
Basically `handle_error` when called on a `RoutingDsl`, the resulting
service should also implement `RoutingDsl`, but if called on another
random service it should _not_ implement `RoutingDsl`.
I don't think thats possible by having `handle_error` on `ServiceExt`
which is implemented for any service, since all axum routers are also
services by design.
This resolves the issue by removing `ServiceExt` and moving its methods
to `RoutingDsl`. Then we have more tight control over what has a
`handle_error` method.
`service::OnMethod` now also has a `handle_error` so you can still
handle errors from random services, by doing
`service::any(svc).handle_error(...)`.
2021-08-08 14:30:51 +02:00
- `ServiceExt` has been removed and its methods have been moved to `RoutingDsl` ([#160](https://github.com/tokio-rs/axum/pull/160))
2021-08-08 19:48:30 +02:00
- `extractor_middleware` now requires `RequestBody: Default` ([#167](https://github.com/tokio-rs/axum/pull/167))
- Convert `RequestAlreadyExtracted` to an enum with each possible error variant ([#167](https://github.com/tokio-rs/axum/pull/167))
2021-08-07 22:35:41 +02:00
- These future types have been moved
- `extract::extractor_middleware::ExtractorMiddlewareResponseFuture` moved
to `extract::extractor_middleware::future::ResponseFuture` ([#133](https://github.com/tokio-rs/axum/pull/133))
- `routing::BoxRouteFuture` moved to `routing::future::BoxRouteFuture` ([#133](https://github.com/tokio-rs/axum/pull/133))
- `routing::EmptyRouterFuture` moved to `routing::future::EmptyRouterFuture` ([#133](https://github.com/tokio-rs/axum/pull/133))
- `routing::RouteFuture` moved to `routing::future::RouteFuture` ([#133](https://github.com/tokio-rs/axum/pull/133))
- `service::BoxResponseBodyFuture` moved to `service::future::BoxResponseBodyFuture` ([#133](https://github.com/tokio-rs/axum/pull/133))
2021-08-07 21:22:08 +02:00
- The following types no longer implement `Copy` ([#132](https://github.com/tokio-rs/axum/pull/132))
2021-08-07 16:13:56 +02:00
- `EmptyRouter`
- `ExtractorMiddleware`
- `ExtractorMiddlewareLayer`
2021-08-07 22:35:41 +02:00
- `QueryStringMissing`
2021-08-07 21:22:08 +02:00
- `RequestParts` changes ([#153](https://github.com/tokio-rs/axum/pull/153))
2021-08-07 20:24:13 +02:00
- `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
- These rejections have been removed as they're no longer used
2021-08-07 21:22:08 +02:00
- `MethodAlreadyExtracted` ([#153](https://github.com/tokio-rs/axum/pull/153))
- `UriAlreadyExtracted` ([#153](https://github.com/tokio-rs/axum/pull/153))
- `VersionAlreadyExtracted` ([#153](https://github.com/tokio-rs/axum/pull/153))
- `UrlParamsRejection`
- `InvalidUrlParam`
2021-08-07 22:27:27 +02:00
- The following services have new response future types:
2021-08-07 22:35:41 +02:00
- `service::OnMethod`
- `handler::OnMethod`
- `routing::Nested`
2021-08-06 11:20:42 +02:00
# 0.1.3 (06. August, 2021)
2021-08-02 22:40:33 +02:00
- Fix stripping prefix when nesting services at `/` ([#91](https://github.com/tokio-rs/axum/pull/91))
2021-08-06 11:20:42 +02:00
- Add support for WebSocket protocol negotiation ([#83](https://github.com/tokio-rs/axum/pull/83))
- Use `pin-project-lite` instead of `pin-project` ([#95](https://github.com/tokio-rs/axum/pull/95))
- Re-export `http` crate and `hyper::Server` ([#110](https://github.com/tokio-rs/axum/pull/110))
2021-08-04 17:13:09 +02:00
- Fix `Query` and `Form` extractors giving bad request error when query string is empty. ([#117](https://github.com/tokio-rs/axum/pull/117))
2021-08-06 10:17:57 +02:00
- Add `Path` extractor. ([#124](https://github.com/tokio-rs/axum/pull/124))
2021-08-06 10:31:38 +02:00
- Fixed the implementation of `IntoResponse` of `(HeaderMap, T)` and `(StatusCode, HeaderMap, T)` would ignore headers from `T` ([#137](https://github.com/tokio-rs/axum/pull/137))
2021-08-06 10:38:38 +02:00
- Deprecate `extract::UrlParams` and `extract::UrlParamsMap` . Use `extract::Path` instead ([#138](https://github.com/tokio-rs/axum/pull/138))
2021-08-01 22:13:43 +02:00
# 0.1.2 (01. August, 2021)
2021-07-31 21:05:53 +02:00
- Implement `Stream` for `WebSocket` ([#52](https://github.com/tokio-rs/axum/pull/52))
- Implement `Sink` for `WebSocket` ([#52](https://github.com/tokio-rs/axum/pull/52))
- Implement `Deref` most extractors ([#56](https://github.com/tokio-rs/axum/pull/56))
- Return `405 Method Not Allowed` for unsupported method for route ([#63](https://github.com/tokio-rs/axum/pull/63))
2021-07-31 21:36:30 +02:00
- Add extractor for remote connection info ([#55](https://github.com/tokio-rs/axum/pull/55))
2021-08-01 15:50:57 +02:00
- Improve error message of `MissingExtension` rejections ([#72](https://github.com/tokio-rs/axum/pull/72))
2021-08-01 15:42:50 +02:00
- Improve documentation for routing ([#71](https://github.com/tokio-rs/axum/pull/71))
2021-08-01 15:42:12 +02:00
- Clarify required response body type when routing to `tower::Service` s ([#69](https://github.com/tokio-rs/axum/pull/69))
- Add `axum::body::box_body` to converting an `http_body::Body` to `axum::body::BoxBody` ([#69](https://github.com/tokio-rs/axum/pull/69))
2021-08-01 21:49:17 +02:00
- Add `axum::sse` for Server-Sent Events ([#75](https://github.com/tokio-rs/axum/pull/75))
2021-08-01 21:33:55 +02:00
- Mention required dependencies in docs ([#77](https://github.com/tokio-rs/axum/pull/77))
2021-08-01 21:00:38 +02:00
- Fix WebSockets failing on Firefox ([#76](https://github.com/tokio-rs/axum/pull/76))
2021-06-12 20:18:21 +02:00
2021-07-30 17:20:38 +02:00
# 0.1.1 (30. July, 2021)
- Misc readme fixes.
2021-07-30 17:14:13 +02:00
# 0.1.0 (30. July, 2021)
2021-06-12 20:18:21 +02:00
2021-07-30 17:14:13 +02:00
- Initial release.