1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
use crate::blueprint::conversions::raw_identifiers2callable;
use crate::blueprint::reflection::RawIdentifiers;
use pavex_bp_schema::{Blueprint as BlueprintSchema, Component, WrappingMiddleware};
/// The type returned by [`Blueprint::wrap`].
///
/// It allows you to further configure the behaviour of the registered wrapping
/// middleware.
///
/// [`Blueprint::wrap`]: crate::blueprint::Blueprint::wrap
pub struct RegisteredWrappingMiddleware<'a> {
pub(crate) blueprint: &'a mut BlueprintSchema,
/// The index of the registered middleware in the blueprint's `components` vector.
pub(crate) component_id: usize,
}
impl<'a> crate::blueprint::middleware::RegisteredWrappingMiddleware<'a> {
#[track_caller]
/// Register an error handler.
///
/// If an error handler has already been registered for this middleware, it will be
/// overwritten.
///
/// # Guide
///
/// Check out the ["Error handlers"](https://pavex.dev/docs/guide/errors/error_handlers)
/// section of Pavex's guide for a thorough introduction to error handlers
/// in Pavex applications.
///
/// # Example
///
/// ```rust
/// use pavex::{f, blueprint::Blueprint, middleware::Next};
/// use pavex::response::Response;
/// use std::future::Future;
/// # struct LogLevel;
/// # struct Logger;
/// # struct TimeoutError;
///
/// // 👇 a fallible middleware
/// fn timeout_middleware<C>(next: Next<C>) -> Result<Response, TimeoutError>
/// where
/// C: Future<Output = Response>
/// {
/// // [...]
/// # todo!()
/// }
///
/// fn error_to_response(error: &TimeoutError, log_level: LogLevel) -> Response {
/// // [...]
/// # todo!()
/// }
///
/// # fn main() {
/// let mut bp = Blueprint::new();
/// bp.wrap(f!(crate::timeout_middleware))
/// .error_handler(f!(crate::error_to_response));
/// # }
/// ```
pub fn error_handler(mut self, error_handler: RawIdentifiers) -> Self {
let callable = raw_identifiers2callable(error_handler);
self.wrapping_middleware().error_handler = Some(callable);
self
}
fn wrapping_middleware(&mut self) -> &mut WrappingMiddleware {
let component = &mut self.blueprint.components[self.component_id];
let Component::WrappingMiddleware(c) = component else {
unreachable!("The component should be a wrapping middleware")
};
c
}
}