mirrors/actix-web
1
0
Fork 0
mirror of https://github.com/actix/actix-web.git synced 2024-06-02 13:29:24 +00:00
Code Issues Projects Releases Wiki Activity

Improve the documentation for default_service (#2614)

Browse source
This commit is contained in:
Luca Palmieri 2022-01-28 20:31:54 +00:00 committed by GitHub
parent 21a08ca796
commit a3416112a5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/app.rs
View file

@ -236,9 +236,9 @@ where
self
}
/// Default service to be used if no matching resource could be found.
/// Default service that is invoked when no matching resource could be found.
///
/// It is possible to use services like `Resource`, `Route`.
/// You must use a [`Route`] as default service:
///
/// ```
/// use actix_web::{web, App, HttpResponse};
@ -253,19 +253,6 @@ where
/// .default_service(
/// web::route().to(|| HttpResponse::NotFound()));
/// ```
///
/// It is also possible to use static files as default service.
///
/// ```
/// use actix_web::{web, App, HttpResponse};
///
/// let app = App::new()
/// .service(
/// web::resource("/index.html").to(|| HttpResponse::Ok()))
/// .default_service(
/// web::to(|| HttpResponse::NotFound())
/// );
/// ```
pub fn default_service<F, U>(mut self, svc: F) -> Self
where
F: IntoServiceFactory<U, ServiceRequest>,

8
src/resource.rs
View file

@ -312,9 +312,11 @@ where
}
}
/// 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`.
/// Default service to be used if no matching route could be found.
/// You can pass a [`Route`] as default_service.
///
/// If no default service is specified, a `405 Method Not Allowed` response will be returned to the caller.
/// [`Resource`] does **not** inherit the default handler specified on the parent [`App`](crate::App) or [`Scope`](crate::Scope).
pub fn default_service<F, U>(mut self, f: F) -> Self
where
F: IntoServiceFactory<U, ServiceRequest>,

3
src/scope.rs
View file

@ -264,7 +264,8 @@ where
/// Default service to be used if no matching route could be found.
///
/// If default resource is not registered, app's default resource is being used.
/// If a default service is not registered, it will fall back to the default service of
/// the parent [`App`](crate::App) (see [`App::default_service`](crate::App::default_service).
pub fn default_service<F, U>(mut self, f: F) -> Self
where
F: IntoServiceFactory<U, ServiceRequest>,