Struct ntex::web::Route

pub struct Route<Err: ErrorRenderer = DefaultError> { /* fields omitted */ }

Resource route definition

Route uses builder-like pattern for configuration. If handler is not explicitly set, default 404 Not Found handler is used.

Implementations

impl<Err: ErrorRenderer> Route<Err>

pub fn new() -> Route<Err>

Create new route which matches any request.

impl<Err: ErrorRenderer> Route<Err>

pub fn method(mut self: Self, method: Method) -> Self

Add method guard to the route.

App::new().service(web::resource("/path").route(
    web::route()
        .method(http::Method::CONNECT)
        .guard(guard::Header("content-type", "text/plain"))
        .to(|req: HttpRequest| async { HttpResponse::Ok() }))
);

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

Add guard to the route.

App::new().service(web::resource("/path").route(
    web::route()
        .guard(guard::Get())
        .guard(guard::Header("content-type", "text/plain"))
        .to(|req: HttpRequest| async { HttpResponse::Ok() }))
);

pub fn to<F, Args>(mut self: 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>, 

Set handler function, use request extractors for parameters.

use ntex::web;
use serde_derive::Deserialize;

#[derive(Deserialize)]
struct Info {
    username: String,
}

/// extract path info using serde
async fn index(info: web::types::Path<Info>) -> String {
    format!("Welcome {}!", info.username)
}

fn main() {
    let app = web::App::new().service(
        web::resource("/{username}/index.html") // <- define path parameters
            .route(web::get().to(index))        // <- register handler
    );
}

It is possible to use multiple extractors for one handler function.

use ntex::web;

#[derive(Deserialize)]
struct Info {
    username: String,
}

/// extract path info using serde
async fn index(path: web::types::Path<Info>, query: web::types::Query<HashMap<String, String>>, body: web::types::Json<Info>) -> String {
    format!("Welcome {}!", path.username)
}

fn main() {
    let app = web::App::new().service(
        web::resource("/{username}/index.html") // <- define path parameters
            .route(web::get().to(index))
    );
}

Trait Implementations

impl<Err: ErrorRenderer> IntoRoutes<Err> for Route<Err>

pub fn routes(self) -> Vec<Route<Err>>

impl<Err: ErrorRenderer> ServiceFactory for Route<Err>

type Config = ()

Service factory configuration

type Request = WebRequest<Err>

Requests handled by the service.

type Response = WebResponse

Responses given by the service

type Error = Err::Container

Errors produced by the service

type InitError = ()

Errors produced while building a service.

type Service = RouteService<Err>

The Service value created by this factory

type Future = Ready<Result<RouteService<Err>, ()>>

The future of the ServiceFactory instance.

pub fn new_service(&self, _: ()) -> Self::Future

Create and return a new service value asynchronously.

pub fn map<F, R>(self, f: F) -> MapServiceFactory<Self, F, R> where
    F: FnMut(Self::Response) -> R + Clone, 

Map this service's output to a different type, returning a new service of the resulting type.

pub fn map_err<F, E>(self, f: F) -> MapErrServiceFactory<Self, F, E> where
    F: Fn(Self::Error) -> E + Clone, 

Map this service's error to a different error, returning a new service.

pub fn map_init_err<F, E>(self, f: F) -> MapInitErr<Self, F, E> where
    F: Fn(Self::InitError) -> E + Clone, 

Map this factory's init error to a different error, returning a new service.