Enum caco3_web::json::ApiJson

pub enum ApiJson<T> {
    Data {
        code: Option<Cow<'static, str>>,
        data: Option<T>,
    },
    Error {
        code: Option<Cow<'static, str>>,
        error: Option<Cow<'static, str>>,
    },
}

Standard Api response formatter.

Variants

Data

Fields

code: Option<Cow<'static, str>>

data: Option<T>

Error

Fields

code: Option<Cow<'static, str>>

error: Option<Cow<'static, str>>

Implementations

impl<T: Serialize> ApiJson<T>

pub fn ok(data: T) -> Self

pub fn data_with_code(data: T, code: Cow<'static, str>) -> Self

pub fn error_builder() -> ApiJsonErrorBuilder<T>

impl ApiJson<()>

pub fn unit_error_builder() -> ApiJsonErrorBuilder<()>

Convenience method to build error without specifying generic type parameter

pub fn no_content() -> Self

pub const fn default_error() -> Self

Trait Implementations

impl<T: Serialize> Serialize for ApiJson<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.