Struct Error

pub struct Error { /* private fields */ }

An error type that can act as a specialized version of a ResponseBuilder.

Implementations

impl Error

pub fn new(source: Box<dyn Error + Send + Sync>) -> Self

Create a new Error from the provided source.

pub fn from_io(source: Error) -> Self

Create a new Error from the provided io::Error. The status code of the error returned will correspond to source.kind().

pub fn as_json(self) -> Self

Returns a new Error that will be serialized to JSON when converted to a Response.

pub fn redact(self, f: impl FnOnce(&str) -> Option<String>) -> Self

Returns a new Error that will eagerly map the message that will be included in the body of the Response that will be generated from self by calling the provided closure. If the closure returns None, the message will be left unchanged.

Example

use via::middleware::error_boundary;
use via::{Next, Request};

type Error = Box<dyn std::error::Error + Send + Sync>;

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let mut app = via::app(());

    // Add an `ErrorBoundary` middleware to the route tree that maps
    // errors that occur in subsequent middleware by calling the `redact`
    // function.
    app.include(error_boundary::map(|_, error| {
        error.redact(|message| {
            if message.contains("password") {
                // If password is even mentioned in the error, return an
                // opaque message instead. You'll probably want something
                // more sophisticated than this in production.
                Some("An error occurred...".to_owned())
            } else {
                // Otherwise, use the existing error message.
                None
            }
        })
    }));

    Ok(())
}

pub fn with_message(self, message: String) -> Self

Returns a new Error that will use the provided message instead of calling the Display implementation of the error source when converted to a Response.

pub fn with_status(self, status: StatusCode) -> Self

Sets the status code of that will be used when converted to a Response.

pub fn use_canonical_reason(self) -> Self

Returns a new Error that will use the canonical reason phrase of the status code as the message included in the Response body that is generated when converted to a Response.

Example

use via::middleware::error_boundary;
use via::{Next, Request};

type Error = Box<dyn std::error::Error + Send + Sync>;

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<(), Error> {
    let mut app = via::app(());

    // Add an `ErrorBoundary` middleware to the route tree that maps
    // errors that occur in subsequent middleware by calling the
    // `use_canonical_reason` function.
    app.include(error_boundary::map(|_, error| {
        // Prevent error messages that occur in downstream middleware from
        // leaking into the response body by using the reason phrase of
        // the status code associated with the error.
        error.use_canonical_reason()
    }));

    Ok(())
}

pub fn iter(&self) -> impl Iterator<Item = &dyn StdError>

Returns an iterator over the sources of this error.

pub fn source(&self) -> &(dyn StdError + 'static)

Returns a reference to the error source.

impl Error

pub fn bad_request(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 400 Bad Request status.

pub fn unauthorized(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 401 Unauthorized status.

pub fn payment_required(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 402 Payment Required status.

pub fn forbidden(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 403 Forbidden status.

pub fn not_found(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 404 Not Found status.

pub fn method_not_allowed(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 405 Method Not Allowed status.

pub fn not_acceptable(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 406 Not Acceptable status.

pub fn proxy_authentication_required( source: Box<dyn Error + Send + Sync>, ) -> Self

Returns a new Error from the provided source that will generate a Response with a 407 Proxy Authentication Required status.

pub fn request_timeout(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 408 Request Timeout status.

pub fn conflict(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 409 Conflict status.

pub fn gone(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 410 Gone status.

pub fn length_required(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 411 Length Required status.

pub fn precondition_failed(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 412 Precondition Failed status.

pub fn payload_too_large(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 413 Payload Too Large status.

pub fn uri_too_long(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 414 URI Too Long status.

pub fn unsupported_media_type(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 415 Unsupported Media Type status.

pub fn range_not_satisfiable(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 416 Range Not Satisfiable status.

pub fn expectation_failed(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 417 Expectation Failed status.

pub fn im_a_teapot(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 418 I'm a teapot status.

pub fn misdirected_request(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 421 Misdirected Request status.

pub fn unprocessable_entity(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 422 Unprocessable Entity status.

pub fn locked(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 423 Locked status.

pub fn failed_dependency(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 424 Failed Dependency status.

pub fn upgrade_required(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 426 Upgrade Required status.

pub fn precondition_required(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 428 Precondition Required status.

pub fn too_many_requests(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 429 Too Many Requests status.

pub fn request_header_fields_too_large( source: Box<dyn Error + Send + Sync>, ) -> Self

Returns a new Error from the provided source that will generate a Response with a 431 Request Header Fields Too Large status.

pub fn unavailable_for_legal_reasons( source: Box<dyn Error + Send + Sync>, ) -> Self

Returns a new Error from the provided source that will generate a Response with a 451 Unavailable For Legal Reasons status.

pub fn internal_server_error(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 500 Internal Server Error status.

pub fn not_implemented(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 501 Not Implemented status.

pub fn bad_gateway(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 502 Bad Gateway status.

pub fn service_unavailable(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 503 Service Unavailable status.

pub fn gateway_timeout(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 504 Gateway Timeout status.

pub fn http_version_not_supported(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 505 HTTP Version Not Supported status.

pub fn variant_also_negotiates(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 506 Variant Also Negotiates status.

pub fn insufficient_storage(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 507 Insufficient Storage status.

pub fn loop_detected(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 508 Loop Detected status.

pub fn not_extended(source: Box<dyn Error + Send + Sync>) -> Self

Returns a new Error from the provided source that will generate a Response with a 510 Not Extended status.

pub fn network_authentication_required( source: Box<dyn Error + Send + Sync>, ) -> Self

Returns a new Error from the provided source that will generate a Response with a 511 Network Authentication Required status.

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<Error> for Response

fn from(error: Error) -> Response

Converts to this type from the input type.

impl<T> From<T> for Error

where T: StdError + Send + Sync + 'static,

fn from(source: T) -> Self

Converts to this type from the input type.

impl Serialize for Error

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.