filigree 0.4.1

Filigree web application framework
Documentation 
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

mod http_error;
mod obfuscate_errors;
mod panic_handler;

pub use http_error::*;
pub use obfuscate_errors::*;
pub use panic_handler::*;
use thiserror::Error;

/// An error to return when failing to parse an order_by field.
/// This is used by the autogenerated code.
#[derive(Debug, Error)]
pub enum OrderByError {
    /// The field is not configured to allow sorting
    #[error("Field is not sortable")]
    InvalidField,
    /// This field restricts the direction in which it can be sorted.
    #[error("Field is not sortable in the requested direction")]
    InvalidDirection,
}

impl HttpError for OrderByError {
    type Detail = ();

    fn status_code(&self) -> hyper::StatusCode {
        hyper::StatusCode::BAD_REQUEST
    }

    fn error_kind(&self) -> &'static str {
        ErrorKind::OrderBy.as_str()
    }

    fn error_detail(&self) -> Self::Detail {
        ()
    }
}

/// Attempt to downcast_ref a [error_stack::Frame] into multiple error types,
/// and map the first matching type through a function. The map function should be generic on some
/// trait that the errors all implement, usually HttpError.
///
/// This would usually be used in a context like this:
///
/// ```
/// # use filigree::{
/// #    downref_report_frame,
/// #    errors::{HttpError, OrderByError},
/// #    uploads::UploadInspectorError,
/// # };
/// # #[derive(Debug)]
/// # struct Error {}
/// # impl std::error::Error for Error {}
/// # impl std::fmt::Display for Error {
/// #     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
/// #         write!(f, "Error")
/// #     }
/// # }
/// fn error_code<E: HttpError>(err: &E) -> http::StatusCode {
///     err.status_code()
/// }
///
/// let report = error_stack::Report::new(OrderByError::InvalidField)
///     .change_context(Error{});
///
/// let status_code = report.frames().find_map(|frame| {
///     downref_report_frame!(
///         // The frame
///         frame,
///         // The function to call if we find a matching error.
///         error_code,
///         // The error types to try
///         OrderByError,
///         filigree::uploads::UploadInspectorError
///     )
/// });
///
/// // Should return the status code for OrderByError::InvalidField
/// assert_eq!(status_code, Some(http::StatusCode::BAD_REQUEST));
/// ```
#[macro_export]
macro_rules! downref_report_frame {
    ($frame:ident, $func:expr, $error_type:ty) => {
        $frame.downcast_ref::<$error_type>().map($func)
    };

    ($frame:ident, $func:expr, $error_type:ty, $($more_error_type:ty),+) => {
        $crate::downref_report_frame!($frame, $func, $error_type)
            $(
                .or_else(|| $crate::downref_report_frame!($frame, $func, $more_error_type))
            )+
    };
}