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 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
pub use http::StatusCode; use std::fmt::{Display, Formatter}; use std::future::Future; use std::pin::Pin; use std::result::Result as StdResult; /// Type alias for `StdResult<R, Error>`. pub type Result<R = ()> = StdResult<R, Error>; /// Type alias for `Pin<Box<dyn 'static + Future<Output = Result<R>> + Send>>`. pub type ResultFuture<R = ()> = Pin<Box<dyn 'static + Future<Output = Result<R>> + Send>>; /// Throw an `Err(Error)`. /// /// - `throw!(status_code)` will be expanded to `throw!(status_code, "")` /// - `throw!(status_code, message)` will be expanded to `throw!(status_code, message, true)` /// - `throw!(status_code, message, expose)` will be expanded to `return Err(Error::new(status_code, message, expose));` /// /// ### Example /// ```rust /// use roa_core::{App, throw}; /// use async_std::task::spawn; /// use http::StatusCode; /// /// #[tokio::main] /// async fn main() -> Result<(), Box<dyn std::error::Error>> { /// let (addr, server) = App::new(()) /// .gate_fn(|ctx, next| async move { /// next().await?; // throw /// unreachable!(); /// ctx.resp_mut().await.status = StatusCode::OK; /// Ok(()) /// }) /// .end(|_ctx| async { /// throw!(StatusCode::IM_A_TEAPOT, "I'm a teapot!"); // throw /// unreachable!() /// }) /// .run_local()?; /// spawn(server); /// let resp = reqwest::get(&format!("http://{}", addr)).await?; /// assert_eq!(StatusCode::IM_A_TEAPOT, resp.status()); /// assert_eq!("I'm a teapot!", resp.text().await?); /// Ok(()) /// } /// ``` #[macro_export] macro_rules! throw { ($status_code:expr) => { $crate::throw!($status_code, ""); }; ($status_code:expr, $message:expr) => { $crate::throw!($status_code, $message, true); }; ($status_code:expr, $message:expr, $expose:expr) => { return Err($crate::Error::new($status_code, $message, $expose)); }; } /// The `Error` of roa. #[derive(Debug, Clone)] pub struct Error { /// StatusCode will be responded to client if Error is thrown by the top middleware. /// ### Range /// 1xx/3xx/4xx/5xx /// /// ### Example /// ```rust /// use roa_core::{App, throw}; /// use async_std::task::spawn; /// use http::StatusCode; /// /// #[tokio::main] /// async fn main() -> Result<(), Box<dyn std::error::Error>> { /// let (addr, server) = App::new(()) /// .gate_fn(|mut ctx, next| async move { /// ctx.resp_mut().await.status = StatusCode::OK; /// next().await // not caught /// }) /// .end(|_ctx| async { /// throw!(StatusCode::IM_A_TEAPOT, "I'm a teapot!") // throw /// }) /// .run_local()?; /// spawn(server); /// let resp = reqwest::get(&format!("http://{}", addr)).await?; /// assert_eq!(StatusCode::IM_A_TEAPOT, resp.status()); /// assert_eq!("I'm a teapot!", resp.text().await?); /// Ok(()) /// } /// ``` pub status_code: StatusCode, /// Error kind, is inferred automatically by status code. pub kind: ErrorKind, /// Data will be written to response body if self.expose is true. /// StatusCode will be responded to client if Error is thrown by the top middleware. /// /// ### Example /// ```rust /// use roa_core::{App, throw, Error}; /// use async_std::task::spawn; /// use http::StatusCode; /// /// #[tokio::test] /// async fn exposed() -> Result<(), Box<dyn std::error::Error>> { /// let (addr, server) = App::new(()) /// .end(|_ctx| async { /// throw(StatusCode::IM_A_TEAPOT, "I'm a teapot!") // throw /// }) /// .run_local()?; /// spawn(server); /// let resp = reqwest::get(&format!("http://{}", addr)).await?; /// assert_eq!(StatusCode::IM_A_TEAPOT, resp.status()); /// assert_eq!("I'm a teapot!", resp.text().await?); /// Ok(()) /// } /// /// #[tokio::test] /// async fn not_exposed() -> Result<(), Box<dyn std::error::Error>> { /// let (addr, server) = App::new(()) /// .end(|_ctx| async { /// Err(Error::new(StatusCode::IM_A_TEAPOT, "I'm a teapot!", false)) // throw /// }) /// .run_local()?; /// spawn(server); /// let resp = reqwest::get(&format!("http://{}", addr)).await?; /// assert_eq!(StatusCode::IM_A_TEAPOT, resp.status()); /// assert_eq!("", resp.text().await?); /// Ok(()) /// } /// ``` pub message: String, /// if message exposed. pub expose: bool, } /// Kind of Error. #[derive(Debug, Eq, PartialEq, Copy, Clone)] pub enum ErrorKind { /// [[RFC7231, Section 6.2](https://tools.ietf.org/html/rfc7231#section-6.2)] Informational, /// [[RFC7231, Section 6.4](https://tools.ietf.org/html/rfc7231#section-6.4)] Redirection, /// [[RFC7231, Section 6.5](https://tools.ietf.org/html/rfc7231#section-6.5)] ClientError, /// [[RFC7231, Section 6.6](https://tools.ietf.org/html/rfc7231#section-6.6)] ServerError, } impl ErrorKind { fn infer(status_code: StatusCode) -> Self { use ErrorKind::*; match status_code.as_u16() / 100 { 1 => Informational, 3 => Redirection, 4 => ClientError, 5 => ServerError, _ => panic!( r"status {} cannot be thrown. Please use `ctx.resp_mut().await.status = xxx` to set it. ", status_code ), } } } impl Error { /// Construct an error. pub fn new(status_code: StatusCode, message: impl ToString, expose: bool) -> Self { Self { status_code, kind: ErrorKind::infer(status_code), message: message.to_string(), expose, } } pub(crate) fn need_throw(&self) -> bool { self.kind == ErrorKind::ServerError } } macro_rules! internal_server_error { ($error:ty) => { impl From<$error> for Error { fn from(err: $error) -> Self { Self::new(StatusCode::INTERNAL_SERVER_ERROR, err, false) } } }; } internal_server_error!(std::io::Error); internal_server_error!(http::Error); impl Display for Error { fn fmt(&self, f: &mut Formatter<'_>) -> StdResult<(), std::fmt::Error> { f.write_str(&format!("{}: {}", self.status_code, self.message)) } } impl std::error::Error for Error {}