Struct State 

pub struct State<T>(pub T);

State extractor for application-wide shared state.

Extracts a typed state value from the application state stored in request extensions. The state must have been previously registered with the application.

Type Requirements

The type T must be Clone + Send + Sync + 'static.

Error Responses

• 500 Internal Server Error: State type not found (server configuration error)

Example

use fastapi_core::extract::State;
use std::sync::Arc;

struct DatabasePool { /* ... */ }

#[get("/users")]
async fn list_users(db: State<Arc<DatabasePool>>) -> impl IntoResponse {
    // db.0 contains the Arc<DatabasePool>
    let users = db.query_users().await;
    Json(users)
}

Tuple Fields

0: T

Implementations

impl<T> State<T>

pub fn into_inner(self) -> T

Unwrap the inner value.

Trait Implementations

impl<T: Clone> Clone for State<T>

fn clone(&self) -> State<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for State<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Deref for State<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for State<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> FromRequest for State<T>

where T: Clone + Send + Sync + 'static,

type Error = StateExtractError

Error type when extraction fails.

async fn from_request( _ctx: &RequestContext, req: &mut Request, ) -> Result<Self, Self::Error>

Extract a value from the request.