Struct ntex::web::Resource

pub struct Resource<Err: ErrorRenderer, T = ResourceEndpoint<Err>> { /* fields omitted */ }

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

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

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

Implementations

impl<Err: ErrorRenderer> Resource<Err>

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

impl<Err, T> Resource<Err, T> where
    T: ServiceFactory<Config = (), Request = WebRequest<Err>, Response = WebResponse, Error = Err::Container, InitError = ()>,
    Err: ErrorRenderer, 

pub fn name(self, name: &str) -> Self

Set resource name.

Name is used for url generation.

pub fn guard<G: Guard + 'static>(self, guard: G) -> Self

Add match guard to a resource.

use ntex::web::{self, guard, App, HttpResponse};

async fn index(data: web::types::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(|| async { HttpResponse::MethodNotAllowed() }))
        );
}

pub fn route<U>(self, route: U) -> Self where
    U: IntoRoutes<Err>, 

Register a new route.

use ntex::web::{self, 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(|| async { HttpResponse::Ok() }))
    );
}

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

use ntex::web::{self, guard, App};

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

pub fn data<U: 'static>(self, data: U) -> Self

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 ntex::web::{self, 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
          .app_data(web::types::PayloadConfig::new(4096))
          .route(
              web::get()
                 // register handler
                 .to(index)
          ));
}

pub fn app_data<U: 'static>(self, data: U) -> Self

Set or override application data.

This method overrides data stored with App::app_data()

pub fn to<F, Args>(self, handler: F) -> Self where
    F: Handler<Args, Err>,
    Args: FromRequest<Err> + 'static,
    Args::Error: Into<Err::Container>,
    <F::Output as Responder<Err>>::Error: Into<Err::Container>, 

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

use ntex::web::{self, App, HttpRequest, HttpResponse};

async 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 filter<F>(
    self,
    filter: F
) -> Resource<Err, impl ServiceFactory<Config = (), Request = WebRequest<Err>, Response = WebResponse, Error = Err::Container, InitError = ()>> where
    F: ServiceFactory<Config = (), Request = WebRequest<Err>, Response = Either<WebRequest<Err>, WebResponse>, Error = Err::Container, InitError = ()>, 

Register request filter.

This is similar to App's filters, but filter get invoked on resource level.

pub fn wrap<M>(
    self,
    mw: M
) -> Resource<Err, impl ServiceFactory<Config = (), Request = WebRequest<Err>, Response = WebResponse, Error = Err::Container, InitError = ()>> where
    M: Transform<T::Service, Request = WebRequest<Err>, Response = WebResponse, Error = Err::Container, 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<Err, impl ServiceFactory<Config = (), Request = WebRequest<Err>, Response = WebResponse, Error = Err::Container, InitError = ()>> where
    F: Fn(WebRequest<Err>, &T::Service) -> R + Clone,
    R: Future<Output = Result<WebResponse, Err::Container>>, 

Register a resource middleware function.

This function accepts instance of WebRequest 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 ntex::service::Service;
use ntex::web::{self, App};
use ntex::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) -> Self where
    F: IntoServiceFactory<U>,
    U: ServiceFactory<Config = (), Request = WebRequest<Err>, Response = WebResponse, Error = Err::Container> + 'static,
    U::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<Err, T> IntoServiceFactory<T> for Resource<Err, T> where
    T: ServiceFactory<Config = (), Request = WebRequest<Err>, Response = WebResponse, Error = Err::Container, InitError = ()>,
    Err: ErrorRenderer, 

fn into_factory(self) -> T

Convert Self to a ServiceFactory

impl<Err, T> WebServiceFactory<Err> for Resource<Err, T> where
    T: ServiceFactory<Config = (), Request = WebRequest<Err>, Response = WebResponse, Error = Err::Container, InitError = ()> + 'static,
    Err: ErrorRenderer, 

fn register(self, config: &mut WebServiceConfig<Err>)