Struct actix_web::State

pub struct State<S>(_);

Access an application state

S - application state type

Example

#[macro_use] extern crate serde_derive;
use actix_web::{http, App, Path, State};

/// Application state
struct MyApp {
    msg: &'static str,
}

#[derive(Deserialize)]
struct Info {
    username: String,
}

/// extract path info using serde
fn index(state: State<MyApp>, path: Path<Info>) -> String {
    format!("{} {}!", state.msg, path.username)
}

fn main() {
    let app = App::with_state(MyApp { msg: "Welcome" }).resource(
        "/{username}/index.html", // <- define path parameters
        |r| r.method(http::Method::GET).with(index),
    ); // <- use `with` extractor
}

Trait Implementations

impl<S> Deref for State<S>

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &S

Dereferences the value.

impl<S> FromRequest<S> for State<S>

type Config = ()

Configuration for conversion process

type Result = State<S>

Future that resolves to a Self

fn from_request(req: &HttpRequest<S>, _: &Self::Config) -> Self::Result

Convert request to a Self

fn extract(req: &HttpRequest<S>) -> Self::Result

Convert request to a Self