pub struct Resource<Err: ErrorRenderer, M = Identity, T = Filter<Err>> { /* private fields */ }
Expand description
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§
source§impl<Err: ErrorRenderer> Resource<Err>
impl<Err: ErrorRenderer> Resource<Err>
pub fn new<T: IntoPattern>(path: T) -> Resource<Err>
source§impl<Err, M, T> Resource<Err, M, T>where
T: ServiceFactory<WebRequest<Err>, Response = WebRequest<Err>, Error = Err::Container, InitError = ()>,
Err: ErrorRenderer,
impl<Err, M, T> Resource<Err, M, T>where
T: ServiceFactory<WebRequest<Err>, Response = WebRequest<Err>, Error = Err::Container, InitError = ()>,
Err: ErrorRenderer,
sourcepub fn guard<G: Guard + 'static>(self, guard: G) -> Self
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() }))
);
}
sourcepub fn state<D: 'static>(self, st: D) -> Self
pub fn state<D: 'static>(self, st: D) -> Self
Provide resource specific state. This method allows to add extractor
configuration or specific state available via State<T>
extractor.
Provided state is available for all routes registered for the current resource.
Resource state overrides state registered by App::state()
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
.state(web::types::PayloadConfig::new(4096))
.route(
// register handler
web::get().to(index)
));
}
sourcepub fn route<R>(self, route: R) -> Selfwhere
R: IntoRoutes<Err>,
pub fn route<R>(self, route: R) -> Selfwhere
R: 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)
])
);
}
sourcepub fn to<F, Args>(self, handler: F) -> Selfwhere
F: Handler<Args, Err> + 'static,
Args: FromRequest<Err> + 'static,
Args::Error: Into<Err::Container>,
pub fn to<F, Args>(self, handler: F) -> Selfwhere
F: Handler<Args, Err> + 'static,
Args: FromRequest<Err> + 'static,
Args::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)));
sourcepub fn filter<U, F>(
self,
filter: F
) -> Resource<Err, M, impl ServiceFactory<WebRequest<Err>, Response = WebRequest<Err>, Error = Err::Container, InitError = ()>>where
U: ServiceFactory<WebRequest<Err>, Response = WebRequest<Err>, Error = Err::Container>,
F: IntoServiceFactory<U, WebRequest<Err>>,
pub fn filter<U, F>(
self,
filter: F
) -> Resource<Err, M, impl ServiceFactory<WebRequest<Err>, Response = WebRequest<Err>, Error = Err::Container, InitError = ()>>where
U: ServiceFactory<WebRequest<Err>, Response = WebRequest<Err>, Error = Err::Container>,
F: IntoServiceFactory<U, WebRequest<Err>>,
Register request filter.
This is similar to App's
filters, but filter get invoked on resource level.
sourcepub fn wrap<U>(self, mw: U) -> Resource<Err, Stack<M, U>, T>
pub fn wrap<U>(self, mw: U) -> Resource<Err, Stack<M, U>, T>
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.
sourcepub fn default_service<F, S>(self, f: F) -> Selfwhere
F: IntoServiceFactory<S, WebRequest<Err>>,
S: ServiceFactory<WebRequest<Err>, Response = WebResponse, Error = Err::Container> + 'static,
S::InitError: Debug,
pub fn default_service<F, S>(self, f: F) -> Selfwhere
F: IntoServiceFactory<S, WebRequest<Err>>,
S: ServiceFactory<WebRequest<Err>, Response = WebResponse, Error = Err::Container> + 'static,
S::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
.