Struct ApiResponse

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

Standard API response wrapper

Fields

success: bool

Success status

data: Option<T>

Response data (present on success)

error: Option<ApiError>

Error information (present on failure)

meta: Option<HashMap<String, Value>>

Additional metadata

Implementations

impl<T> ApiResponse<T>

pub fn success(data: T) -> Self

Create a successful response

pub fn success_with_meta(data: T, meta: HashMap<String, Value>) -> Self

Create a successful response with metadata

pub fn error(error: ApiError) -> Self

Create an error response

Trait Implementations

impl<T: Clone> Clone for ApiResponse<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for ApiResponse<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> 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.