Skip to main content

ExceptionHandlers

Struct ExceptionHandlers 

Source
pub struct ExceptionHandlers { /* private fields */ }
Expand description

Registry for custom exception handlers.

This allows applications to register handlers for specific error types, converting errors into HTTP responses in a customizable way.

§Default Handlers

The registry comes with default handlers for common error types:

§Example

use fastapi_core::app::ExceptionHandlers;
use fastapi_core::{RequestContext, Response, HttpError};

#[derive(Debug)]
struct MyCustomError(String);

impl std::fmt::Display for MyCustomError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "Custom error: {}", self.0)
    }
}

impl std::error::Error for MyCustomError {}

let handlers = ExceptionHandlers::new()
    .handler(|_ctx, err: MyCustomError| {
        Response::with_status(StatusCode::BAD_REQUEST)
            .body_json(&serde_json::json!({"error": err.0}))
    });

Implementations§

Source§

impl ExceptionHandlers

Source

pub fn new() -> Self

Creates a new empty exception handler registry.

Source

pub fn with_defaults() -> Self

Creates a registry with default handlers for common error types.

Source

pub fn register<E>( &mut self, handler: impl Fn(&RequestContext, E) -> Response + Send + Sync + 'static, )
where E: Error + Send + Sync + 'static,

Registers a handler for a specific error type.

The handler receives the error value directly (not boxed) for type safety. If a handler for the same type already exists, it is replaced.

Source

pub fn handler<E>( self, handler: impl Fn(&RequestContext, E) -> Response + Send + Sync + 'static, ) -> Self
where E: Error + Send + Sync + 'static,

Registers a handler for a specific error type (builder pattern).

Source

pub fn handle<E>(&self, ctx: &RequestContext, err: E) -> Option<Response>
where E: Error + Send + Sync + 'static,

Handles an error by finding and invoking the appropriate handler.

Returns Some(Response) if a handler was found for the error type, or None if no handler is registered.

Source

pub fn handle_or_default<E>(&self, ctx: &RequestContext, err: E) -> Response
where E: Error + Send + Sync + 'static,

Handles an error, falling back to a default 500 response if no handler is found.

Source

pub fn has_handler<E: 'static>(&self) -> bool

Returns true if a handler is registered for the given error type.

Source

pub fn len(&self) -> usize

Returns the number of registered handlers.

Source

pub fn is_empty(&self) -> bool

Returns true if no handlers are registered.

Source

pub fn merge(&mut self, other: ExceptionHandlers)

Merges another handler registry into this one.

Handlers from other will override handlers in self for the same error types.

Trait Implementations§

Source§

impl Debug for ExceptionHandlers

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ExceptionHandlers

Source§

fn default() -> ExceptionHandlers

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ResponseProduces<T> for T