[]Struct paperclip::actix::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, HttpResponse, Responder};

struct MyData {
    counter: usize,
}

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

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

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

Methods

impl<T> Data<T>

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

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

Get reference to inner app data.

pub fn into_inner(self) -> Arc<T>

Convert to the internal Arc

Methods from Deref<Target = Arc<T>>

Trait Implementations

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

impl<T> Clone for Data<T>

impl<T> Debug for Data<T> where
    T: Debug

impl<T> Deref for Data<T>

type Target = Arc<T>

The resulting type after dereferencing.

impl<T> FromRequest for Data<T> where
    T: 'static, 

type Config = ()

Configuration for this extractor

type Error = Error

The associated error which can be returned.

type Future = Ready<Result<Data<T>, Error>>

Future that resolves to a Self

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

Auto Trait Implementations

impl<T> RefUnwindSafe for Data<T> where
    T: RefUnwindSafe

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

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

impl<T> Unpin for Data<T>

impl<T> UnwindSafe for Data<T> where
    T: RefUnwindSafe

Blanket Implementations

impl<T, A, P> Access<T> for P where
    A: Access<T>,
    P: Deref<Target = A>, 
[src]

type Guard = <A as Access<T>>::Guard

A guard object containing the value and keeping it alive. Read more

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

impl<T> Apiv2Schema for T where
    T: TypedData
[src]

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

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

impl<T, A> DynAccess<T> for A where
    A: Access<T>,
    <A as Access<T>>::Guard: 'static, 
[src]

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, U> TryInto<U> for T where
    U: TryFrom<T>, 

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

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