RespErr

Struct RespErr 

Source
pub struct RespErr {
    pub status_code: StatusCode,
    /* private fields */
}
Expand description

An error to be used as the error variant of a request handler.

Often initialized by using RespErrCtx::ctx on Result, Option or Response. But it can also be initialized by RespErr::new.

§Examples

use axum_ctx::*;

fn can_fail() -> Result<(), std::io::Error> {
    // …
}

async fn get() -> Result<StatusCode, RespErr> {
    can_fail()
        .ctx(StatusCode::INTERNAL_SERVER_ERROR)
        .user_msg("Sorry for disappointing you. Do you want a cookie?")
        .log_msg("Failed to do …. Blame Max Mustermann")?;
    // …
    Ok(StatusCode::OK)
}

Using the type alias RespResult is recommended:

async fn get() -> RespResult<StatusCode> {
    // …
}

Fields§

§status_code: StatusCode

Implementations§

Source§

impl RespErr

Source

pub const fn new(status_code: StatusCode) -> Self

Initialize with a status.

Source

pub fn user_msg(self, message: impl Into<Message>) -> Self

Optionally add a custom user error message.

Source

pub fn log_msg(self, error: impl Into<Message>) -> Self

Optionally add an error message to be showed in the log. It will not be shown to the user!

Trait Implementations§

Source§

impl Debug for RespErr

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for RespErr

Source§

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

Formats the value using the given formatter. Read more
Source§

impl IntoResponse for RespErr

Source§

fn into_response(self) -> Response

Log the error, set the HTTP status code and return the response.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more