Struct ErrorResponseContext

Source

pub struct ErrorResponseContext { /* private fields */ }

Expand description

A structured context containing error information for generating HTTP responses.

This struct holds the essential components of an error response:

HTTP status code
Error code (for API consumers)
Human-readable error message

It can be used by custom error response functions to access error details and generate appropriate responses in any desired format.

§Example

use axum_error_handler::ErrorResponseContext;
 
let context = ErrorResponseContext::builder()
    .status_code(404)
    .code("NOT_FOUND".to_string())
    .message("Resource not found".to_string())
    .build();
 
assert_eq!(context.status_code(), Some(404));
assert_eq!(context.code(), Some(&"NOT_FOUND".to_string()));

Implementations§

Source §

impl ErrorResponseContext

Source

pub fn builder() -> ErrorResponseBuilder

Creates a new builder for constructing an ErrorResponseContext.

This is the recommended way to create a new context with specific values.

§Example

use axum_error_handler::ErrorResponseContext;
 
let context = ErrorResponseContext::builder()
    .status_code(400)
    .code("VALIDATION_ERROR".to_string())
    .message("Invalid input provided".to_string())
    .build();

Source

pub fn new() -> ErrorResponseContext

Creates a new empty ErrorResponseContext.

All fields will be None initially. Use the builder pattern or the setter methods to populate the context.

Source

pub fn status_code(&self) -> Option<u16>

Returns the HTTP status code if set.

§Returns

Some(status_code) if a status code was set, None otherwise.

Source

pub fn code(&self) -> Option<&String>

Returns a reference to the error code if set.

§Returns

Some(&code) if an error code was set, None otherwise.

Source

pub fn message(&self) -> Option<&String>

Returns a reference to the error message if set.

§Returns

Some(&message) if a message was set, None otherwise.

Trait Implementations§

Source §

impl Clone for ErrorResponseContext

Source §

fn clone(&self) -> ErrorResponseContext

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 IntoResponse for ErrorResponseContext

Default implementation for converting an ErrorResponseContext into an Axum HTTP response.

This implementation creates a standardized JSON response with the following format:

{
  "result": null,
  "error": {
    "code": "ERROR_CODE",
    "message": "Error description"
  }
}

§Defaults

Status code: 500 (Internal Server Error) if not specified
Error code: “UNKNOWN_ERROR” if not specified
Message: “An error occurred” if not specified

§Example

use axum::response::IntoResponse;
use axum_error_handler::ErrorResponseContext;
 
let context = ErrorResponseContext::builder()
    .status_code(404)
    .code("NOT_FOUND".to_string())
    .message("The requested resource was not found".to_string())
    .build();
 
let response = context.into_response();
// Creates a 404 response with JSON body

Source §