Struct poem::error::Error

pub struct Error { /* fields omitted */ }

General response error.

Create from any error types

use poem::{error::InternalServerError, handler, Result};

#[handler]
async fn index() -> Result<String> {
    Ok(std::fs::read_to_string("example.txt").map_err(InternalServerError)?)
}

Create you own error type

use poem::{error::ResponseError, handler, http::StatusCode, Result};

#[derive(Debug, thiserror::Error)]
#[error("my error")]
struct MyError;

impl ResponseError for MyError {
    fn status(&self) -> StatusCode {
        StatusCode::BAD_GATEWAY
    }
}

fn do_something() -> Result<(), MyError> {
    todo!()
}

#[handler]
async fn index() -> Result<()> {
    Ok(do_something()?)
}

Downcast the error to concrete error type

use poem::{error::NotFoundError, Error};

let err: Error = NotFoundError.into();

assert!(err.is::<NotFoundError>());
assert_eq!(err.downcast_ref::<NotFoundError>(), Some(&NotFoundError));

Implementations

impl Error

pub fn new<T: StdError + Send + Sync + 'static>(
    err: T,
    status: StatusCode
) -> Self

Create a new error object from any error type with 503 INTERNAL_SERVER_ERROR status code.

pub fn from_status(status: StatusCode) -> Self

create a new error object from status code.

pub fn from_string(msg: impl Into<String>, status: StatusCode) -> Self

Create a new error object from string with 503 INTERNAL_SERVER_ERROR status code.

pub fn status(&self) -> StatusCode

Returns the status code of this error.

pub fn downcast_ref<T: StdError + Send + Sync + 'static>(&self) -> Option<&T>

Downcast this error object by reference.

pub fn downcast<T: StdError + Send + Sync + 'static>(self) -> Result<T, Error>

Attempts to downcast the error to a concrete error type.

pub fn is<T: StdError + Debug + Send + Sync + 'static>(&self) -> bool

Returns true if the error type is the same as T.

pub fn as_response(&self) -> Response

Consumes this to return a response object.

Trait Implementations

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<'_>) -> Result

Formats the value using the given formatter.

impl From<(StatusCode, Box<dyn Error + Sync + Send + 'static, Global>)> for Error

fn from((status, err): (StatusCode, Box<dyn StdError + Send + Sync>)) -> Self

Performs the conversion.

impl From<(StatusCode, Error)> for Error

fn from((status, err): (StatusCode, Error)) -> Self

Performs the conversion.

impl From<Box<dyn Error + Sync + Send + 'static, Global>> for Error

fn from(err: Box<dyn StdError + Send + Sync>) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(err: Error) -> Self

Performs the conversion.

impl From<Infallible> for Error

fn from(_: Infallible) -> Self

Performs the conversion.

impl From<StatusCode> for Error

fn from(status: StatusCode) -> Self

Performs the conversion.

impl<T: ResponseError + StdError + Send + Sync + 'static> From<T> for Error

fn from(err: T) -> Self

Performs the conversion.