[][src]Struct actix_web::web::Data

pub struct Data<T>(_);

Application data.

Application data is an arbitrary data attached to the app. Application data is available to all routes and could be added during application configuration process with App::data() method.

Application data could be accessed by using Data<T> extractor where T is data type.

Note: http server accepts an application factory rather than an application instance. Http server constructs an application instance for each thread, thus application data must be constructed multiple times. If you want to share data between different threads, a shareable object should be used, e.g. Send + Sync. Application data does not need to be Send or Sync. Internally Data type uses Arc. if your data implements Send + Sync traits you can use web::Data::new() and avoid double Arc.

If route data is not set for a handler, using Data<T> extractor would cause Internal Server Error response.

use std::sync::Mutex;
use actix_web::{web, App};

struct MyData {
    counter: usize,
}

/// Use `Data<T>` extractor to access data in handler.
fn index(data: web::Data<Mutex<MyData>>) {
    let mut data = data.lock().unwrap();
    data.counter += 1;
}

fn main() {
    let data = web::Data::new(Mutex::new(MyData{ counter: 0 }));

    let app = App::new()
        // Store `MyData` in application storage.
        .register_data(data.clone())
        .service(
            web::resource("/index.html").route(
                web::get().to(index)));
}

Methods

impl<T> Data<T>[src]

pub fn new(state: T) -> Data<T>[src]

Create new Data instance.

Internally Data type uses Arc. if your data implements Send + Sync traits you can use web::Data::new() and avoid double Arc.

pub fn get_ref(&self) -> &T[src]

Get reference to inner app data.

Trait Implementations

impl<T: 'static> FromRequest for Data<T>[src]

type Config = ()

Configuration for this extractor

type Error = Error

The associated error which can be returned.

type Future = Result<Self, Error>

Future that resolves to a Self

fn extract(req: &HttpRequest) -> Self::Future[src]

Convert request to a Self Read more

fn configure<F>(f: F) -> Self::Config where
    F: FnOnce(Self::Config) -> Self::Config
[src]

Create and configure config instance.

impl<T> Clone for Data<T>[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<T: Debug> Debug for Data<T>[src]

impl<T> Deref for Data<T>[src]

type Target = T

The resulting type after dereferencing.

Auto Trait Implementations

impl<T> Send for Data<T> where
    T: Send + Sync

impl<T> Sync for Data<T> where
    T: Send + Sync

Blanket Implementations

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Erased for T

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,