Enum ApiResponse 

pub enum ApiResponse<T: Serialize> {
    Success(StatusCode, T),
    Error(StatusCode, String),
}

A unified response type that handlers can return.

Converts into a properly-typed axum Response with the correct status code and a JSON body using either [SuccessBody] or [ErrorBody].

Usage

async fn get_user() -> ApiResponse<User> {
    let user = User { name: "Alice".into() };
    ApiResponse::ok(user)
}

async fn not_found() -> ApiResponse<()> {
    ApiResponse::error(StatusCode::NOT_FOUND, "resource not found")
}

Variants

Success(StatusCode, T)

Error(StatusCode, String)

Implementations

impl<T: Serialize> ApiResponse<T>

pub fn ok(data: T) -> Self

200 OK with a data payload.

pub fn created(data: T) -> Self

201 Created with a data payload.

pub fn success(status: StatusCode, data: T) -> Self

Arbitrary success status with a data payload.

pub fn error(status: StatusCode, message: impl Into<String>) -> Self

Error response with a status code and message.

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

400 Bad Request.

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

404 Not Found.

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

401 Unauthorized.

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

403 Forbidden.

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

500 Internal Server Error.

Trait Implementations

impl<T: Serialize> IntoResponse for ApiResponse<T>

fn into_response(self) -> Response

Create a response.