pub struct Resource<T = ResourceEndpoint> { /* private fields */ }
Expand description
A collection of Route
s that respond to the same path pattern.
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.
§Examples
use actix_web::{web, App, HttpResponse};
let app = App::new().service(
web::resource("/")
.get(|| HttpResponse::Ok())
.post(|| async { "Hello World!" })
);
If no matching route is found, an empty 405 response is returned which includes an
appropriate Allow header. This default behavior can be overridden using
default_service()
.
Implementations§
source§impl Resource
impl Resource
sourcepub fn new<T: IntoPatterns>(path: T) -> Resource
pub fn new<T: IntoPatterns>(path: T) -> Resource
Constructs new resource that matches a path
pattern.
source§impl<T> Resource<T>
impl<T> Resource<T>
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 actix_web::{web, guard, App, HttpResponse};
async fn index(data: web::Path<(String, String)>) -> &'static str {
"Welcome!"
}
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()))
);
sourcepub fn route(self, route: Route) -> Self
pub fn route(self, route: Route) -> Self
Register a new route.
use actix_web::{web, guard, App, HttpResponse};
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};
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))
);
sourcepub fn app_data<U: 'static>(self, data: U) -> Self
pub fn app_data<U: 'static>(self, data: U) -> Self
Add resource data.
Data of different types from parent contexts will still be accessible. Any Data<T>
types
set here can be extracted in handlers using the Data<T>
extractor.
§Examples
use std::cell::Cell;
use actix_web::{web, App, HttpRequest, HttpResponse, Responder};
struct MyData {
count: std::cell::Cell<usize>,
}
async fn handler(req: HttpRequest, counter: web::Data<MyData>) -> impl Responder {
// note this cannot use the Data<T> extractor because it was not added with it
let incr = *req.app_data::<usize>().unwrap();
assert_eq!(incr, 3);
// update counter using other value from app data
counter.count.set(counter.count.get() + incr);
HttpResponse::Ok().body(counter.count.get().to_string())
}
let app = App::new().service(
web::resource("/")
.app_data(3usize)
.app_data(web::Data::new(MyData { count: Default::default() }))
.route(web::get().to(handler))
);
sourcepub fn data<U: 'static>(self, data: U) -> Self
👎Deprecated since 4.0.0: Use .app_data(Data::new(val))
instead.
pub fn data<U: 'static>(self, data: U) -> Self
.app_data(Data::new(val))
instead.Add resource data after wrapping in Data<T>
.
Deprecated in favor of app_data
.
sourcepub fn to<F, Args>(self, handler: F) -> Self
pub fn to<F, Args>(self, handler: F) -> Self
Register a new route and add handler. This route matches all requests.
use actix_web::{App, HttpRequest, HttpResponse, web};
async fn index(req: HttpRequest) -> HttpResponse {
todo!()
}
App::new().service(web::resource("/").to(index));
This is shortcut for:
App::new().service(web::resource("/").route(web::route().to(index)));
sourcepub fn wrap<M, B>(
self,
mw: M,
) -> Resource<impl ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse<B>, Error = Error, InitError = ()>>where
M: Transform<T::Service, ServiceRequest, Response = ServiceResponse<B>, Error = Error, InitError = ()> + 'static,
B: MessageBody,
pub fn wrap<M, B>(
self,
mw: M,
) -> Resource<impl ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse<B>, Error = Error, InitError = ()>>where
M: Transform<T::Service, ServiceRequest, Response = ServiceResponse<B>, Error = Error, InitError = ()> + 'static,
B: MessageBody,
Registers a resource middleware.
mw
is a middleware component (type), that can modify the request and response across all
routes managed by this Resource
.
See App::wrap
for more details.
sourcepub fn wrap_fn<F, R, B>(
self,
mw: F,
) -> Resource<impl ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse<B>, Error = Error, InitError = ()>>where
F: Fn(ServiceRequest, &T::Service) -> R + Clone + 'static,
R: Future<Output = Result<ServiceResponse<B>, Error>>,
B: MessageBody,
pub fn wrap_fn<F, R, B>(
self,
mw: F,
) -> Resource<impl ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse<B>, Error = Error, InitError = ()>>where
F: Fn(ServiceRequest, &T::Service) -> R + Clone + 'static,
R: Future<Output = Result<ServiceResponse<B>, Error>>,
B: MessageBody,
Registers a resource function middleware.
mw
is a closure that runs during inbound and/or outbound processing in the request
life-cycle (request -> response), modifying request/response as necessary, across all
requests handled by the Resource
.
See App::wrap_fn
for examples and more details.
sourcepub fn default_service<F, U>(self, f: F) -> Selfwhere
F: IntoServiceFactory<U, ServiceRequest>,
U: ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse, Error = Error> + 'static,
U::InitError: Debug,
pub fn default_service<F, U>(self, f: F) -> Selfwhere
F: IntoServiceFactory<U, ServiceRequest>,
U: ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse, Error = Error> + 'static,
U::InitError: Debug,
Sets the default service to be used if no matching route is found.
Unlike Scope
s, a Resource
does not inherit its parent’s default service. You can
use a Route
as default service.
If a custom default service is not registered, an empty 405 Method Not Allowed
response
with an appropriate Allow header will be sent instead.
§Examples
use actix_web::{App, HttpResponse, web};
let resource = web::resource("/test")
.route(web::get().to(HttpResponse::Ok))
.default_service(web::to(|| {
HttpResponse::BadRequest()
}));
App::new().service(resource);
source§impl<T> Resource<T>
impl<T> Resource<T>
Concise routes for well-known HTTP methods.