Struct ApiResponse 

pub struct ApiResponse<T, C, D = ()> { /* private fields */ }

REST wire contract: {code,msg,data?,error?}.

Fields are private; constructors and deserialization enforce code/state consistency. This type has no web-framework dependency and never chooses a status, header or error message.

use aster_forge_api::response::{ApiResponse, ApiResponseCode};
#[derive(serde::Serialize)]
enum ProductCode { Success }
impl ApiResponseCode for ProductCode {
    fn is_success(&self) -> bool { matches!(self, Self::Success) }
}
let response = ApiResponse::<_, ProductCode>::ok(ProductCode::Success, vec![1, 2])?;
assert_eq!(response.data(), Some(&vec![1, 2]));

Callers cannot bypass state validation with a struct literal:

use aster_forge_api::response::ApiResponse;
let response = ApiResponse::<(), u8> {
    code: 0, msg: String::new(), data: Some(()), error: None,
};

Implementations

impl<T, C: ApiResponseCode, D> ApiResponse<T, C, D>

pub fn ok(code: C, data: T) -> Result<Self, ResponseEnvelopeError>

Builds success with data and an empty message, preserving a null-valued T as data.

Errors

Returns ResponseEnvelopeError::SuccessCodeRequired for a failure code.

pub fn ok_with_message( code: C, message: impl Into<String>, data: T, ) -> Result<Self, ResponseEnvelopeError>

Builds success with a product-provided message and data.

Errors

Returns ResponseEnvelopeError::SuccessCodeRequired for a failure code.

impl<C: ApiResponseCode, D> ApiResponse<(), C, D>

pub fn ok_empty(code: C) -> Result<Self, ResponseEnvelopeError>

Builds success with an empty message and omitted data.

Errors

Returns ResponseEnvelopeError::SuccessCodeRequired for a failure code.

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

Builds a failure with retryable: false and no diagnostic, matching AD’s ordinary error.

Errors

Returns ResponseEnvelopeError::FailureCodeRequired for a success code.

pub fn error_with_details( code: C, message: impl Into<String>, error: Option<ApiErrorInfo<D>>, ) -> Result<Self, ResponseEnvelopeError>

Builds a failure with optional product error metadata. None omits the error field.

Errors

Returns ResponseEnvelopeError::FailureCodeRequired for a success code.

impl<C: ApiResponseCode, D> ApiResponse<ApiEmptyData, C, D>

pub fn ok_empty_data(code: C) -> Result<Self, ResponseEnvelopeError>

Builds success with data: {} and an empty message.

Errors

Returns ResponseEnvelopeError::SuccessCodeRequired for a failure code.

impl<T, C, D> ApiResponse<T, C, D>

pub const fn code(&self) -> &C

The product’s typed code.

pub fn message(&self) -> &str

Product-provided message.

pub const fn data(&self) -> Option<&T>

Data if the success includes a data field.

pub fn into_data(self) -> Option<T>

Consumes the envelope and returns its optional data payload.

pub const fn error_info(&self) -> Option<&ApiErrorInfo<D>>

Optional product error metadata.

Trait Implementations

impl<T: Clone, C: Clone, D: Clone> Clone for ApiResponse<T, C, D>

fn clone(&self) -> ApiResponse<T, C, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: ToSchema, C: ToSchema, D: ToSchema> ComposeSchema for ApiResponse<T, C, D>

fn compose(_generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl<T: Debug, C: Debug, D: Debug> Debug for ApiResponse<T, C, D>

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

Formats the value using the given formatter.

impl<'de, T, C, D> Deserialize<'de> for ApiResponse<T, C, D>

where T: Deserialize<'de>, C: Deserialize<'de> + ApiResponseCode, D: Deserialize<'de>,

fn deserialize<E: Deserializer<'de>>(deserializer: E) -> Result<Self, E::Error>

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq, C: PartialEq, D: PartialEq> PartialEq for ApiResponse<T, C, D>

fn eq(&self, other: &ApiResponse<T, C, D>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, C, D> Serialize for ApiResponse<T, C, D>

where T: Serialize, C: Serialize, D: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: ToSchema, C: ToSchema, D: ToSchema> ToSchema for ApiResponse<T, C, D>

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.

impl<T: Eq, C: Eq, D: Eq> Eq for ApiResponse<T, C, D>

impl<T, C, D> StructuralPartialEq for ApiResponse<T, C, D>