Struct ntex::web::types::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::types::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 ntex::web::{self, App, HttpResponse};

struct MyData {
    counter: usize,
}

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

fn main() {
    let data = web::types::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)));
}

Implementations

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::types::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> Clone for Data<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T> Deref for Data<T>

type Target = Arc<T>

The resulting type after dereferencing.

fn deref(&self) -> &Arc<T>

Dereferences the value.

impl<T: 'static, E: ErrorRenderer> FromRequest<E> for Data<T>

type Error = DataExtractorError

The associated error which can be returned.

type Future = Ready<Self, Self::Error>

Future that resolves to a Self

fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future

Convert request to a Self

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

Convert request to a Self