Struct actix_web::web::RouteData

pub struct RouteData<T>(_);

Route data.

Route data is an arbitrary data attached to specific route. Route data could be added to route during route configuration process with Route::data() method. Route data is also used as an extractor configuration storage. Route data could be accessed in handler via RouteData<T> extractor.

If route data is not set for a handler, using RouteData extractor would cause Internal Server Error response.

use actix_web::{web, App};

struct MyData {
    counter: Cell<usize>,
}

/// Use `RouteData<T>` extractor to access data in handler.
fn index(data: web::RouteData<MyData>) {
    data.counter.set(data.counter.get() + 1);
}

fn main() {
    let app = App::new().service(
        web::resource("/index.html").route(
            web::get()
               // Store `MyData` in route storage
               .data(MyData{ counter: Cell::new(0) })
               // Route data could be used as extractor configuration storage,
               // limit size of the payload
               .data(web::PayloadConfig::new(4096))
               // register handler
               .to(index)
        ));
}

Methods

impl<T> RouteData<T>

pub fn get_ref(&self) -> &T

Get referecnce to inner data object.

Trait Implementations

impl<T: 'static, P> FromRequest<P> for RouteData<T>

type Error = Error

The associated error which can be returned.

type Future = Result<Self, Error>

Future that resolves to a Self

fn from_request(req: &mut ServiceFromRequest<P>) -> Self::Future

Convert request to a Self

impl<T> Clone for RouteData<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Deref for RouteData<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.