Struct ApiResult 

pub struct ApiResult<T> {
    pub success: bool,
    pub data: Option<ResponseData<T>>,
    pub message: Option<String>,
    pub code: Option<i32>,
    pub pagination: Option<ResultPagination>,
    pub errors: Option<Vec<FieldError>>,
    pub trace_id: Option<String>,
    pub biz_code: Option<i32>,
    pub timestamp: Option<i64>,
    pub extra: Option<Value>,
}

API response wrapper with unified structure

Fields

success: bool

data: Option<ResponseData<T>>

message: Option<String>

code: Option<i32>

pagination: Option<ResultPagination>

errors: Option<Vec<FieldError>>

trace_id: Option<String>

biz_code: Option<i32>

timestamp: Option<i64>

extra: Option<Value>

Implementations

impl<T> ApiResult<T>

pub fn value(v: T) -> Self

Create a successful response with a single value

pub fn list(v: Vec<T>) -> Self

Create a successful response with a list of values

pub fn fail(message: &str) -> Self

Create a failed response with a message (alias for failure)

pub fn failure(message: &str) -> Self

Create a failed response with a message

pub fn success() -> Self

Create a successful response without data

Alias for ok() - use ok() for clarity

pub fn ok() -> Self

Create a successful response without data (recommended method name)

pub fn validation_errors(errors: Vec<FieldError>) -> Self

Create a validation error response with field-level details

pub fn from_result<E: Display>(result: Result<T, E>) -> Self

Convert a Result<T, E> into ApiResult<T>, mapping all errors to InternalError

pub fn is_success(&self) -> bool

Whether this is a successful response

pub fn is_error(&self) -> bool

Whether this is an error response

pub fn error_code(&self) -> Option<ErrorCode>

Get the error code if this is an error response

pub fn with_extra(self, key: &str, value: Value) -> Self

Add extra metadata to the response

pub fn with_code(self, code: i32) -> Self

Set error code for the response

pub fn with_pagination(self, pagination: ResultPagination) -> Self

Set pagination metadata for list responses

pub fn with_message(self, message: &str) -> Self

Set message for the response

pub fn with_errors(self, errors: Vec<FieldError>) -> Self

Set field-level validation errors

pub fn with_error( self, field: impl Into<String>, message: impl Into<String>, ) -> Self

Add a single field-level validation error

pub fn with_trace_id(self, id: impl Into<String>) -> Self

Set request trace ID

pub fn with_biz_code(self, code: i32) -> Self

Set business error code (independent of HTTP status code)

pub fn with_timestamp(self, ts: i64) -> Self

Set timestamp (Unix milliseconds)

pub fn with_current_timestamp(self) -> Self

Set timestamp to current time automatically

Trait Implementations

impl<T: Clone> Clone for ApiResult<T>

fn clone(&self) -> ApiResult<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ApiResult<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for ApiResult<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, E> From<ApiResult<T>> for Result<ApiResult<T>, E>

Convert ApiResult<T> into Result<ApiResult<T>, E> for any error type E.

This allows ApiResult::value(data).into() to work as a shorthand for Ok(ApiResult::value(data)) in handlers returning DefaultResult<impl Responder>.

The conversion always produces Ok — the Err variant is never used because ApiResult itself encodes success/failure in its success field.

fn from(val: ApiResult<T>) -> Self

Converts to this type from the input type.

impl<T> From<Error> for ApiResult<T>

fn from(err: Error) -> Self

Converts to this type from the input type.

impl<T> From<Error> for ApiResult<T>

fn from(err: Error) -> Self

Converts to this type from the input type.

impl<T> From<FromUtf8Error> for ApiResult<T>

fn from(err: FromUtf8Error) -> Self

Converts to this type from the input type.

impl<T, E: Display + Debug> From<Result<T, E>> for ApiResult<T>

Convert any Result<T, E> where E implements Display to ApiResult<T>

fn from(result: Result<T, E>) -> Self

Converts to this type from the input type.

impl<T: Serialize> Responder for ApiResult<T>

Available on crate feature actix only.

Actix-web framework integration for ApiResult.

When ApiResultLayer middleware is active, the trace_id is automatically injected from request extensions into the response.

type Body = BoxBody

fn respond_to(self, req: &HttpRequest) -> HttpResponse<Self::Body>

Convert self to HttpResponse.

fn customize(self) -> CustomizeResponder<Self>

where Self: Sized,

Wraps responder to allow alteration of its response.

impl<T> Serialize for ApiResult<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.