Struct roa_core::Error

pub struct Error {
    pub status_code: StatusCode,
    pub kind: ErrorKind,
    pub message: String,
    pub expose: bool,
}

The Error of roa.

Fields

status_code: StatusCode

StatusCode will be responded to client if Error is thrown by the top middleware.

Range

1xx/3xx/4xx/5xx

Example

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 {
            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(())
}

kind: ErrorKind

Error kind, is inferred automatically by status code.

message: String

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

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(())
}

expose: bool

if message exposed.

Methods

impl Error

pub fn new(
    status_code: StatusCode,
    message: impl ToString,
    expose: bool
) -> Self

Construct an error.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

fn fmt(&self, f: &mut Formatter) -> StdResult<(), Error>

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

Deprecated since 1.41.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<Error> for Error

fn from(err: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(err: Error) -> Self

Performs the conversion.