OpenSource/axum
OpenSource/axum
1
0
Fork 0
mirror of https://github.com/tokio-rs/axum.git synced 2024-11-24 08:06:36 +01:00
Code Issues Projects Releases Packages Wiki Activity

Improve docs regarding state and extensions (#2991)

Browse source 
Co-authored-by: David Mládek <david.mladek.cz@gmail.com>
This commit is contained in:
Leon Lux 2024-10-21 21:47:20 +02:00 committed by GitHub
parent 72819848e3
commit 280d16a610
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 6 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
axum/src/docs/routing/with_state.md
View file

@ -1,4 +1,5 @@
Provide the state for the router.
Provide the state for the router. State passed to this method is global and will be used
for all requests this router receives. That means it is not suitable for holding state derived from a request, such as authorization data extracted in a middleware. Use [`Extension`] instead for such data.
```rust
use axum::{Router, routing::get, extract::State};
@ -94,13 +95,6 @@ axum::serve(listener, routes).await.unwrap();
# };
```
# State is global within the router
The state passed to this method will be used for all requests this router
receives. That means it is not suitable for holding state derived from a
request, such as authorization data extracted in a middleware. Use [`Extension`]
instead for such data.
# What `S` in `Router<S>` means
`Router<S>` means a router that is _missing_ a state of type `S` to be able to

4
axum/src/extract/state.rs
View file

@ -10,7 +10,11 @@ use std::{
/// See ["Accessing state in middleware"][state-from-middleware] for how to
/// access state in middleware.
///
/// State is global and used in every request a router with state receives.
/// For accessing data derived from requests, such as authorization data, see [`Extension`].
///
/// [state-from-middleware]: crate::middleware#accessing-state-in-middleware
/// [`Extension`]: crate::Extension
///
/// # With `Router`
///