Enum Error 

pub enum Error {
    InvalidArgs(Vec<String>),
    Unauthorized(String),
    Forbidden(String),
    NotFound(String),
    Conflict(String),
    InvalidEntity(Vec<String>),
    Internal,
    ServiceUnavailable,
}

Available on crate feature axum only.

Error that can be used as axum response, with an appropriate HTTP status code and – except for Internal – with one or more error messages conveyed as a JSON string array.

Variants

InvalidArgs(Vec<String>)

400 Bad Request, e.g. because of invalid path or query arguments.

Unauthorized(String)

401 Unauthorized.

Forbidden(String)

403 Forbidden.

NotFound(String)

404 Not Found.

Conflict(String)

409 Conflict, e.g. because of an already existing resource.

InvalidEntity(Vec<String>)

422 Unprocessable Entity, e.g. because of the JSON payload could not be parsed.

Internal

500 Internal Server Error.

ServiceUnavailable

503 Service Unavailable.

Implementations

impl Error

pub fn invalid_args<T>(error: T) -> Self

where T: ToString,

Create Error::InvalidArgs with the given error.

pub fn invalid_args_all<I, T>(errors: I) -> Self

where I: IntoIterator<Item = T>, T: ToString,

Create Error::InvalidArgs with the given errors.

pub fn unauthorized<T>(error: T) -> Self

where T: ToString,

Create Error::Unauthorized with the given error.

pub fn forbidden<T>(error: T) -> Self

where T: ToString,

Create Error::Forbidden with the given error.

pub fn not_found<T>(error: T) -> Self

where T: ToString,

Create Error::NotFound with the given error.

pub fn conflict<T>(error: T) -> Self

where T: ToString,

Create Error::Conflict with the given error.

pub fn invalid_entity<T>(error: T) -> Self

where T: ToString,

Create Error::InvalidEntity with the given error.

pub fn invalid_entity_all<I, T>(errors: I) -> Self

where I: IntoIterator<Item = T>, T: ToString,

Create Error::InvalidEntity with the given errors.

Trait Implementations

impl ComposeSchema for Error

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for Error

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

Formats the value using the given formatter.

impl IntoResponse for Error

fn into_response(self) -> Response

Create a response.

impl ToSchema for Error

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.