Struct actix_web_lab::middleware::ErrorHandlers

pub struct ErrorHandlers<B> { /* private fields */ }

Middleware for registering custom status code based error handlers.

Register handlers with the ErrorHandlers::handler() method to register a custom error handler for a given status code. Handlers can modify existing responses or create completely new ones.

Examples

use actix_web::{
    body::EitherBody,
    http::{header, StatusCode},
    dev::ServiceResponse,
    web, App, HttpResponse, Result
};
use actix_web_lab::middleware::ErrorHandlers;

async fn add_error_header<B>(mut res: ServiceResponse<B>) -> Result<ServiceResponse<EitherBody<B>>> {
    res.response_mut().headers_mut().insert(
        header::CONTENT_TYPE,
        header::HeaderValue::from_static("Error"),
    );
    Ok(res.map_into_left_body())
}

let app = App::new()
    .wrap(ErrorHandlers::new().handler(StatusCode::INTERNAL_SERVER_ERROR, add_error_header))
    .service(web::resource("/").route(web::get().to(HttpResponse::InternalServerError)));

Implementations

impl<B> ErrorHandlers<B>

pub fn new() -> Self

Construct new ErrorHandlers instance.

pub fn handler<F, Fut>(self, status: StatusCode, handler: F) -> Selfwhere
    F: Fn(ServiceResponse<B>) -> Fut + 'static,
    Fut: Future<Output = Result<ServiceResponse<EitherBody<B>>>> + 'static,

Register error handler for specified status code.

Trait Implementations

impl<B> Default for ErrorHandlers<B>

fn default() -> Self

Returns the “default value” for a type.

impl<S, B> Transform<S, ServiceRequest> for ErrorHandlers<B>where
    S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
    S::Future: 'static,
    B: 'static,

type Response = ServiceResponse<EitherBody<B, BoxBody>>

Responses produced by the service.

type Error = Error

Errors produced by the service.

type Transform = ErrorHandlersMiddleware<S, B>

The TransformService value created by this factory

type InitError = ()

Errors produced while building a transform service.

type Future = Pin<Box<dyn Future<Output = Result<<ErrorHandlers<B> as Transform<S, ServiceRequest>>::Transform, <ErrorHandlers<B> as Transform<S, ServiceRequest>>::InitError>> + 'static, Global>>

The future response value.

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously