Enum ApiResponse

pub enum ApiResponse<Data, Meta> {
    Success(SuccessResponse<Data, Meta>),
    Error(ErrorResponse<Meta>),
}

Enum to represent the overall API response

Variants

Success(SuccessResponse<Data, Meta>)

Error(ErrorResponse<Meta>)

Implementations

impl<Data, Meta> ApiResponse<Data, Meta>

pub const fn new_success(data: Data, meta: Meta) -> Self

pub const fn from_success(data: Data) -> Self

pub const fn from_success_data(data: Data) -> Self

pub const fn new_error(error: ApiError, meta: Meta) -> Self

pub const fn from_error(error: ApiError) -> Self

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

pub fn from_error_source( code: impl Into<u32>, source: impl Error + Send + Sync + 'static, set_source_detail: bool, message: Option<String>, ) -> Self

pub fn with_meta(self, meta: Meta) -> Self

pub fn set_meta(&mut self, meta: Meta) -> &mut Self

pub const fn is_success(&self) -> bool

pub const fn is_error(&self) -> bool

pub const fn get_meta(&self) -> Option<&Meta>

pub fn expect(self, expect_msg: &str) -> SuccessResponse<Data, Meta>

Panics

If it is ApiResponse::Error, trigger a panic using the expect_msg parameter.

pub fn unwrap(self) -> SuccessResponse<Data, Meta>

Panics

If it is ApiResponse::Error, trigger a panic.

pub fn unwrap_err(self) -> ErrorResponse<Meta>

Panics

If it is ApiResponse::Success, trigger a panic.

pub fn into_result(self) -> ApiResult<Data, Meta>

pub fn into_result_data(self) -> Result<Data, ErrorResponse<Meta>>

pub fn into_result_without_meta(self) -> Result<Data, ApiError>

Trait Implementations

impl<Data: Debug, Meta: Debug> Debug for ApiResponse<Data, Meta>

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

Formats the value using the given formatter.

impl<'de, Data, Meta> Deserialize<'de> for ApiResponse<Data, Meta>

where Data: Deserialize<'de>, Meta: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Data, Meta> From<ApiError> for ApiResponse<Data, Meta>

fn from(error: ApiError) -> Self

Converts to this type from the input type.

impl<Data, Meta> From<ApiResponse<Data, Meta>> for Result<Data, ApiError>

fn from(api_response: ApiResponse<Data, Meta>) -> Self

Converts to this type from the input type.

impl<Data, Meta> From<ApiResponse<Data, Meta>> for ApiResult<Data, Meta>

fn from(api_response: ApiResponse<Data, Meta>) -> Self

Converts to this type from the input type.

impl<Data, Meta> From<ErrorResponse<Meta>> for ApiResponse<Data, Meta>

fn from(value: ErrorResponse<Meta>) -> Self

Converts to this type from the input type.

impl<Data, Meta> From<Result<Data, ApiError>> for ApiResponse<Data, Meta>

fn from(result: Result<Data, ApiError>) -> Self

Converts to this type from the input type.

impl<Data, Meta> From<Result<SuccessResponse<Data, Meta>, ErrorResponse<Meta>>> for ApiResponse<Data, Meta>

where Meta: Default,

fn from(result: ApiResult<Data, Meta>) -> Self

Converts to this type from the input type.

impl<Data, Meta> From<SuccessResponse<Data, Meta>> for ApiResponse<Data, Meta>

fn from(value: SuccessResponse<Data, Meta>) -> Self

Converts to this type from the input type.

impl<Data, Meta> Serialize for ApiResponse<Data, Meta>

where Data: Serialize, Meta: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.