Struct ApiResponse

pub struct ApiResponse<T>
where
    T: Serialize,
{
    pub success: bool,
    pub data: Option<T>,
    pub message: String,
}

Standardized API response wrapper for all outgoing JSON responses.

This struct enforces a consistent response structure across all endpoints:

{
  "success": true,
  "data": { ... },
  "message": "Some message"
}

• T is the type of the data payload.
• success is a boolean indicating operation status.
• message provides a human-readable context string.

Example (success):

{
  "success": true,
  "data": { "id": 1, "name": "Alice" },
  "message": "User fetched successfully"
}

Example (error):

{
  "success": false,
  "data": {},
  "message": "User not found"
}

Fields

success: bool

data: Option<T>

message: String

Implementations

impl<T> ApiResponse<T>

where T: Serialize,

pub fn success(data: T, message: impl Into<String>) -> Self

Constructs a success response with the given data and message.

Arguments

• data: The result payload.
• message: A descriptive message to accompany the success.

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

Constructs a success response with no data, only a message.

Arguments

• message: A descriptive message to accompany the success.

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

Constructs an error response with a message and no data.

Arguments

• message: A description of the error.

Trait Implementations

impl<T> Serialize for ApiResponse<T>

where T: Serialize + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.