Skip to main content

HttpException

Struct HttpException 

Source
pub struct HttpException {
    pub status: StatusCode,
    pub code: &'static str,
    pub message: String,
    pub details: Option<Value>,
    pub request_id: Option<String>,
}
Expand description

HttpException

The framework’s primary error type for HTTP responses. Enables controllers to return proper HTTP error responses without manually constructing response objects.

§Fields

  • status: The HTTP status code
  • code: A machine-readable error code for programmatic error handling
  • message: A human-readable error message
  • details: Optional additional error details (often validation errors)
  • request_id: Optional request ID for correlation

Fields§

§status: StatusCode§code: &'static str§message: String§details: Option<Value>§request_id: Option<String>

Implementations§

Source§

impl HttpException

Source

pub fn new( status: StatusCode, code: &'static str, message: impl Into<String>, ) -> Self

Generic constructor for creating an HttpException.

§Arguments
  • status: The HTTP status code
  • code: A machine-readable error code
  • message: A human-readable error message
Source

pub fn with_details( status: StatusCode, code: &'static str, message: impl Into<String>, details: Value, ) -> Self

Constructor that includes additional error details.

§Arguments
  • status: The HTTP status code
  • code: A machine-readable error code
  • message: A human-readable error message
  • details: Additional error details (often used for validation errors)
Source

pub fn with_request_id(self, request_id: impl Into<String>) -> Self

Attaches a request ID to the exception for correlation.

Source

pub fn with_optional_request_id(self, request_id: Option<String>) -> Self

Attaches an optional request ID to the exception.

Source

pub fn bad_request(message: impl Into<String>) -> Self

Creates a 400 Bad Request error.

Source

pub fn bad_request_validation(errors: ValidationErrors) -> Self

Creates a 400 Bad Request error with validation errors.

Source

pub fn unauthorized(message: impl Into<String>) -> Self

Creates a 401 Unauthorized error.

Source

pub fn forbidden(message: impl Into<String>) -> Self

Creates a 403 Forbidden error.

Source

pub fn not_found(message: impl Into<String>) -> Self

Creates a 404 Not Found error.

Source

pub fn internal_server_error(message: impl Into<String>) -> Self

Creates a 500 Internal Server Error.

Trait Implementations§

Source§

impl Clone for HttpException

Source§

fn clone(&self) -> HttpException

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for HttpException

Source§

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

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

impl IntoResponse for HttpException

IntoResponse Implementation

Makes HttpException directly returnable from axum handlers. This enables returning Result<Json<T>, HttpException> from controllers and having axum automatically convert the error into a proper HTTP response.

Source§

fn into_response(self) -> Response

Create a 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T, S> Handler<IntoResponseHandler, S> for T
where T: IntoResponse + Clone + Send + Sync + 'static,

Source§

type Future = Ready<Response<Body>>

The type of future calling this handler returns.
Source§

fn call( self, _req: Request<Body>, _state: S, ) -> <T as Handler<IntoResponseHandler, S>>::Future

Call the handler with the given request.
Source§

fn layer<L>(self, layer: L) -> Layered<L, Self, T, S>
where L: Layer<HandlerService<Self, T, S>> + Clone, <L as Layer<HandlerService<Self, T, S>>>::Service: Service<Request<Body>>,

Apply a tower::Layer to the handler. Read more
Source§

fn with_state(self, state: S) -> HandlerService<Self, T, S>

Convert the handler into a Service by providing the state
Source§

impl<H, T> HandlerWithoutStateExt<T> for H
where H: Handler<T, ()>,

Source§

fn into_service(self) -> HandlerService<H, T, ()>

Convert the handler into a Service and no state.
Source§

fn into_make_service(self) -> IntoMakeService<HandlerService<H, T, ()>>

Convert the handler into a MakeService and no state. Read more
Source§

fn into_make_service_with_connect_info<C>( self, ) -> IntoMakeServiceWithConnectInfo<HandlerService<H, T, ()>, C>

Convert the handler into a MakeService which stores information about the incoming connection and has no state. Read more
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> IntoInjectableResult<T> for T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,