Struct ApiResponse 

pub struct ApiResponse<T> {
    pub success: bool,
    pub data: Option<T>,
    pub error: Option<String>,
    pub code: Option<&'static str>,
}

API response wrapper.

Fields

success: bool

Whether the request did what was asked. Read this, not the presence of data.

data: Option<T>

The payload, on success.

error: Option<String>

What went wrong, on failure.

code: Option<&'static str>

A stable, machine-readable name for what went wrong, on failure.

error is prose and may be reworded; this is what a client should match on. Absent on success, and on the few failures that predate it.

Implementations

impl<T: Serialize> ApiResponse<T>

pub fn success(data: T) -> Self

A successful response carrying data.

pub fn error(message: impl Into<String>) -> ApiResponse<()>

A failure response carrying message and no data.

Returns ApiResponse<()> regardless of T: there is no payload to type, and requiring the caller to name one at every error site would be noise.

pub fn error_with_code( code: &'static str, message: impl Into<String>, ) -> ApiResponse<()>

A failure response carrying a stable code as well as message.

Trait Implementations

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.