Struct Resource 

pub struct Resource<T = ResourceEndpoint> { /* private fields */ }

Resource is an entry in resources table which corresponds to requested URL.

Resource in turn has at least one route. Route consists of an handlers objects and list of guards (objects that implement Guard trait). Resources and routes uses builder-like pattern for configuration. During request handling, resource object iterate through all routes and check guards for specific route, if request matches all guards, route considered matched and route handler get called.

use actix_web::{web, App, HttpResponse};

fn main() {
    let app = App::new().service(
        web::resource("/")
            .route(web::get().to(|| HttpResponse::Ok())));
}

If no matching route could be found, 405 response code get returned. Default behavior could be overridden with default_resource() method.

Implementations

impl Resource

pub fn new<T>(path: T) -> Resource

where T: IntoPattern,

impl<T> Resource<T>

where T: ServiceFactory<Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = ()>,

pub fn name(self, name: &str) -> Resource<T>

Set resource name.

Name is used for url generation.

pub fn guard<G>(self, guard: G) -> Resource<T>

where G: Guard + 'static,

Add match guard to a resource.

use actix_web::{web, guard, App, HttpResponse};

async fn index(data: web::Path<(String, String)>) -> &'static str {
    "Welcome!"
}

fn main() {
    let app = App::new()
        .service(
            web::resource("/app")
                .guard(guard::Header("content-type", "text/plain"))
                .route(web::get().to(index))
        )
        .service(
            web::resource("/app")
                .guard(guard::Header("content-type", "text/json"))
                .route(web::get().to(|| HttpResponse::MethodNotAllowed()))
        );
}

pub fn route(self, route: Route) -> Resource<T>

Register a new route.

use actix_web::{web, guard, App, HttpResponse};

fn main() {
    let app = App::new().service(
        web::resource("/").route(
            web::route()
                .guard(guard::Any(guard::Get()).or(guard::Put()))
                .guard(guard::Header("Content-Type", "text/plain"))
                .to(|| HttpResponse::Ok()))
    );
}

Multiple routes could be added to a resource. Resource object uses match guards for route selection.

use actix_web::{web, guard, App};

fn main() {
    let app = App::new().service(
        web::resource("/container/")
             .route(web::get().to(get_handler))
             .route(web::post().to(post_handler))
             .route(web::delete().to(delete_handler))
    );
}

pub fn data<U>(self, data: U) -> Resource<T>

where U: 'static,

Provide resource specific data. This method allows to add extractor configuration or specific state available via Data<T> extractor. Provided data is available for all routes registered for the current resource. Resource data overrides data registered by App::data() method.

use actix_web::{web, App, FromRequest};

/// extract text data from request
async fn index(body: String) -> String {
    format!("Body {}!", body)
}

fn main() {
    let app = App::new().service(
        web::resource("/index.html")
          // limit size of the payload
          .data(String::configure(|cfg| {
               cfg.limit(4096)
          }))
          .route(
              web::get()
                 // register handler
                 .to(index)
          ));
}

pub fn app_data<U>(self, data: U) -> Resource<T>

where U: 'static,

Add resource data.

Data of different types from parent contexts will still be accessible.

pub fn to<F, I, R, U>(self, handler: F) -> Resource<T>

where F: Factory<I, R, U>, I: FromRequest + 'static, R: Future<Output = U> + 'static, U: Responder + 'static,

Register a new route and add handler. This route matches all requests.

use actix_web::*;

fn index(req: HttpRequest) -> HttpResponse {
    unimplemented!()
}

App::new().service(web::resource("/").to(index));

This is shortcut for:

App::new().service(web::resource("/").route(web::route().to(index)));

pub fn wrap<M>( self, mw: M, ) -> Resource<impl ServiceFactory<Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = ()>>

where M: Transform<<T as ServiceFactory>::Service, Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = ()>,

Register a resource middleware.

This is similar to App's middlewares, but middleware get invoked on resource level. Resource level middlewares are not allowed to change response type (i.e modify response’s body).

Note: middlewares get called in opposite order of middlewares registration.

pub fn wrap_fn<F, R>( self, mw: F, ) -> Resource<impl ServiceFactory<Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = ()>>

where F: FnMut(ServiceRequest, &mut <T as ServiceFactory>::Service) -> R + Clone, R: Future<Output = Result<ServiceResponse, Error>>,

Register a resource middleware function.

This function accepts instance of ServiceRequest type and mutable reference to the next middleware in chain.

This is similar to App's middlewares, but middleware get invoked on resource level. Resource level middlewares are not allowed to change response type (i.e modify response’s body).

use actix_service::Service;
use actix_web::{web, App};
use actix_web::http::{header::CONTENT_TYPE, HeaderValue};

async fn index() -> &'static str {
    "Welcome!"
}

fn main() {
    let app = App::new().service(
        web::resource("/index.html")
            .wrap_fn(|req, srv| {
                let fut = srv.call(req);
                async {
                    let mut res = fut.await?;
                    res.headers_mut().insert(
                       CONTENT_TYPE, HeaderValue::from_static("text/plain"),
                    );
                    Ok(res)
                }
            })
            .route(web::get().to(index)));
}

pub fn default_service<F, U>(self, f: F) -> Resource<T>

where F: IntoServiceFactory<U>, U: ServiceFactory<Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error> + 'static, <U as ServiceFactory>::InitError: Debug,

Default service to be used if no matching route could be found. By default 405 response get returned. Resource does not use default handler from App or Scope.

Trait Implementations

impl<T> HttpServiceFactory for Resource<T>

where T: ServiceFactory<Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = ()> + 'static,

fn register(self, config: &mut AppService)

impl<T> IntoServiceFactory<T> for Resource<T>

where T: ServiceFactory<Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = ()>,

fn into_factory(self) -> T

Convert Self to a ServiceFactory