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 extra: Option<Value>,
}

API response wrapper with unified structure

Fields

• success: Indicates if the request was successful
• data: Contains either a single value or a list (via ResponseData)
• message: Optional message or error description
• code: Optional error code
• pagination: Optional pagination metadata for list responses
• extra: Additional metadata as key-value pairs

JSON Serialization Examples

// Single value
{ "success": true, "data": { "id": 1, "name": "Alice" } }

// List
{ "success": true, "data": [{ "id": 1 }, { "id": 2 }], "pagination": {...} }

// Empty success
{ "success": true }

// Error
{ "success": false, "message": "Not found", "code": 404 }

Fields

success: bool

data: Option<ResponseData<T>>

message: Option<String>

code: Option<i32>

pagination: Option<ResultPagination>

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 to avoid confusion with the success field

pub fn ok() -> Self

Create a successful response without data (recommended method name)

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

Add extra metadata to the response

Example

use anycms_core::ApiResult;
use serde_json::json;

let result: ApiResult<()> = ApiResult::ok()
    .with_extra("timestamp", json!(1234567890))
    .with_extra("version", json!("1.0.0"));

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

Trait Implementations

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> From<ApiError> for ApiResult<T>

fn from(err: ApiError) -> Self

Converts to this type from the input type.

impl<T> From<AppError> for ApiResult<T>

fn from(err: AppError) -> 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, 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, E> Into<Result<ApiResult<T>, E>> for ApiResult<T>

Conversion into Result for convenient error handling

fn into(self) -> Result<ApiResult<T>, E>

Converts this type into the (usually inferred) input type.

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

Available on crate feature actix only.

Actix-web framework integration for ApiResult

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.