Struct hyperdrive::Error

pub struct Error { /* fields omitted */ }

The error type used by the Hyperdrive library.

This type can be turned into an HTTP response and sent back to a client.

Methods

impl Error

pub fn from_status(status: StatusCode) -> Self

Creates an error that contains just the given StatusCode.

Panics

This will panic when called with a status that does not indicate a client or server error.

pub fn with_source<S>(status: StatusCode, source: S) -> Self where
    S: Into<BoxedError>, 

Creates an error from an HTTP error code and an underlying error that caused this one.

Responding with the returned Error will not send a response body back to the client.

Parameters

• status: The HTTP StatusCode describing the error.
• source: The underlying error that caused this one. Any type implementing std::error::Error + Send + Sync can be passed here.

Panics

This will panic when called with a status that does not indicate a client or server error.

pub fn wrong_method<M>(allowed_methods: M) -> Self where
    M: Into<Cow<'static, [&'static Method]>>, 

Creates an error with status code 405 Method Not Allowed and includes the allowed set of HTTP methods.

This is called by the code generated by #[derive(FromRequest)] and usually does not need to be called by the user (it may be difficult to determine the full set of allowed methods for a given path).

Calling Error::response on the error created by this function will automatically include an Allow header listing all allowed methods. Including this header is required by RFC 7231.

Parameters

• allowed_methods: The list of allowed HTTP methods for the path in the request. This can be empty, but usually should contain at least one method.

pub fn http_status(&self) -> StatusCode

Returns the HTTP status code that describes this error.

pub fn response(&self) -> Response<()>

Creates an HTTP response for indicating this error to the client.

No body will be provided (hence the () body type), but the caller can map the result to supply one.

Example

Call map on the response to supply your own HTTP payload:

use http::StatusCode;
use hyper::Body;

let error = Error::from_status(StatusCode::NOT_FOUND);
let response = error.response()
    .map(|()| Body::from("oh no!"));

pub fn allowed_methods(&self) -> Option<&[&'static Method]>

If self is a 405 Method Not Allowed error, returns the list of allowed methods.

Returns None if self is a different kind of error.

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

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

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

fn description(&self) -> &str

This method is soft-deprecated.

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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