OpenSource/axum
OpenSource/axum
1
0
Fork 0
mirror of https://github.com/tokio-rs/axum.git synced 2024-11-29 19:52:40 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fix some out of date docs (#784)

Browse source 
Since https://github.com/tokio-rs/axum/pull/698 this section about
`HeaderMap` removing the headers from the request is no longer true.
This commit is contained in:
David Pedersen 2022-02-24 16:22:52 +01:00 committed by GitHub
parent ccd7bd91a6
commit e781b7b936
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
axum/src/docs/extract.md
View file

@ -136,38 +136,10 @@ async fn get_user_things(
# };
```
Take care of the order in which you apply extractors as some extractors
mutate the request.
For example using [`HeaderMap`] as an extractor will make the headers
inaccessible for other extractors on the handler. If you need to extract
individual headers _and_ a [`HeaderMap`] make sure to apply the extractor of
individual headers first:
```rust,no_run
use axum::{
extract::TypedHeader,
routing::get,
headers::UserAgent,
http::header::HeaderMap,
Router,
};
async fn handler(
TypedHeader(user_agent): TypedHeader<UserAgent>,
all_headers: HeaderMap,
) {
// ...
}
let app = Router::new().route("/", get(handler));
# async {
# axum::Server::bind(&"".parse().unwrap()).serve(app.into_make_service()).await.unwrap();
# };
```
Extractors that consume the request body can also only be applied once as
well as [`Request`], which consumes the entire request:
Take care of the order in which you apply extractors as some will mutate the
request. For example extractors that consume the request body can only be
applied once. The same is true for [`Request`], which consumes the entire
request:
```rust,no_run
use axum::{