From 34e5c7c799b88dcd18ebaf8c4b8d75132e19bf25 Mon Sep 17 00:00:00 2001
From: Mark Lodato <mlodato517@gmail.com>
Date: Fri, 24 Dec 2021 21:35:19 -0500
Subject: [PATCH] Improve module docs for error handler middleware (#2543)
---
src/middleware/err_handlers.rs | 26 ++++++++++----------------
1 file changed, 10 insertions(+), 16 deletions(-)
diff --git a/src/middleware/err_handlers.rs b/src/middleware/err_handlers.rs
index 6d064372..bde05433 100644
--- a/src/middleware/err_handlers.rs
+++ b/src/middleware/err_handlers.rs
@@ -37,27 +37,21 @@ type ErrorHandler<B> = dyn Fn(ServiceResponse<B>) -> Result<ErrorHandlerResponse
///
/// # Examples
/// ```
-/// use actix_web::middleware::{ErrorHandlers, ErrorHandlerResponse};
-/// use actix_web::{web, dev, App, HttpRequest, HttpResponse, Result};
-/// use actix_web::http::{StatusCode, header};
-///
-/// fn render_500<B>(mut res: dev::ServiceResponse<B>) -> Result<ErrorHandlerResponse<B>> {
-/// res.response_mut()
-/// .headers_mut()
-/// .insert(header::CONTENT_TYPE, header::HeaderValue::from_static("Error"));
+/// use actix_web::http::{header, StatusCode};
+/// use actix_web::middleware::{ErrorHandlerResponse, ErrorHandlers};
+/// use actix_web::{dev, web, App, HttpResponse, Result};
///
+/// fn add_error_header<B>(mut res: dev::ServiceResponse<B>) -> Result<ErrorHandlerResponse<B>> {
+/// res.response_mut().headers_mut().insert(
+/// header::CONTENT_TYPE,
+/// header::HeaderValue::from_static("Error"),
+/// );
/// Ok(ErrorHandlerResponse::Response(res.map_into_left_body()))
/// }
///
/// let app = App::new()
-/// .wrap(
-/// ErrorHandlers::new()
-/// .handler(StatusCode::INTERNAL_SERVER_ERROR, render_500),
-/// )
-/// .service(web::resource("/test")
-/// .route(web::get().to(|| HttpResponse::Ok()))
-/// .route(web::head().to(|| HttpResponse::MethodNotAllowed())
-/// ));
+/// .wrap(ErrorHandlers::new().handler(StatusCode::INTERNAL_SERVER_ERROR, add_error_header))
+/// .service(web::resource("/").route(web::get().to(HttpResponse::InternalServerError)));
/// ```
pub struct ErrorHandlers<B> {
handlers: Handlers<B>,