Struct ApiResponse 

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

Standard API response wrapper

Fields

success: bool

data: Option<T>

error: Option<ApiError>

message: Option<String>

Implementations

impl<T> ApiResponse<T>

pub fn success(data: T) -> Self

Create successful response with data

pub fn cast<U>(self) -> ApiResponse<U>

Convert this ApiResponse to another type (for error responses)

pub fn forbidden_typed() -> ApiResponse<T>

Create a forbidden response for any type

pub fn unauthorized_typed() -> ApiResponse<T>

Create an unauthorized response for any type

pub fn error_typed(code: &str, message: impl Into<String>) -> ApiResponse<T>

Create an error response for any type

pub fn validation_error_typed(message: impl Into<String>) -> ApiResponse<T>

Create a validation error response for any type

pub fn not_found_typed(message: impl Into<String>) -> ApiResponse<T>

Create a not found response for any type

pub fn forbidden_with_message_typed( message: impl Into<String>, ) -> ApiResponse<T>

Create a forbidden response with message for any type

pub fn error_with_message_typed( code: &str, message: impl Into<String>, ) -> ApiResponse<T>

Create an error response with message for any type

pub fn not_found_with_message_typed( message: impl Into<String>, ) -> ApiResponse<T>

Create a not found response with message for any type

pub fn internal_error_typed() -> ApiResponse<T>

Create an internal error response for any type

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

Create successful response with message

pub fn ok() -> ApiResponse<()>

Create simple success response

pub fn ok_with_message(message: impl Into<String>) -> ApiResponse<()>

Create success response with message only

impl ApiResponse<()>

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

Create error response

pub fn error_with_details( code: impl Into<String>, message: impl Into<String>, details: Value, ) -> Self

Create error response with details

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

Create validation error

pub fn unauthorized() -> Self

Create unauthorized error

pub fn forbidden() -> Self

Create forbidden error

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

Create forbidden error with custom message

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

Create not found error

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

Create not found error with custom message

pub fn error_with_message( code: impl Into<String>, message: impl Into<String>, ) -> Self

Create error response with custom message

pub fn internal_error() -> Self

Create internal server error

Trait Implementations

impl<T: Debug> Debug for ApiResponse<T>

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

Formats the value using the given formatter.

impl From<AuthError> for ApiResponse<()>

Convert AuthError to API response

fn from(error: AuthError) -> Self

Converts to this type from the input type.

impl<T> IntoResponse for ApiResponse<T>

where T: Serialize,

fn into_response(self) -> Response

Create a response.

impl<T> Serialize for ApiResponse<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.