Struct apisdk::CodeDataMessage

pub struct CodeDataMessage<T = Option<Value>> {
    pub code: i64,
    pub data: T,
    pub message: Option<String>,
    /* private fields */
}

This struct is used to parse {code, data, message} payload.

When it’s used as Extractor, it will extract data from payload.

Examples

As Extractor

To be used as Extractor, CodeDataMessage will check code field of response payload, and ensure it must be 0. If not, it will generate an ApiError instance with code and message.

async fn get_user(&self) -> ApiResult<User> {
    let req = client.get("/api/path").await?;
    send!(req, CodeDataMessage).await
}

As Result

If we want to access the response headers or extra fields, we could use CodeDataMessage as result type.

async fn get_user(&self) -> ApiResult<User> {
    let req = client.get("/api/path").await?;
    let res: CodeDataMessage<User> = send!(req).await?;
    // to access HTTP headers: res.get_header("name")
    // to access extra fields: res.get_extra("other_field")
    if res.is_success() {
        Ok(res.data)
    } else {
        Err(ApiError::BusinessError(res.code, res.get_header().map(|v| v.to_string())))
    }
}

Fields

code: i64

code field

data: T

data field

message: Option<String>

message or msg field

Implementations

impl<T> CodeDataMessage<T>

pub fn is_success(&self) -> bool

Check whether code is 0

pub fn get_header(&self, name: &str) -> Option<&str>

Get any header

• name: header name

pub fn get_extra<D>(&self, name: &str) -> Option<D>

where D: DeserializeOwned,

Get any unknown field

• name: field name

pub fn get_request_id(&self) -> Option<&str>

Get X-Request-ID header

pub fn get_trace_id(&self) -> Option<&str>

Get X-Trace-ID header

pub fn get_span_id(&self) -> Option<&str>

Get X-Span-ID header

Trait Implementations

impl<T: Debug> Debug for CodeDataMessage<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for CodeDataMessage<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 JsonExtractor for CodeDataMessage

fn try_extract<T>(self) -> ApiResult<T>

where T: DeserializeOwned,

Try to extract result from response.

fn require_headers() -> bool

The extractor needs response HTTP headers or not.

impl<T> Serialize for CodeDataMessage<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.

impl TryFrom<ResponseBody> for CodeDataMessage

type Error = ApiError

The type returned in the event of a conversion error.

fn try_from(body: ResponseBody) -> Result<Self, Self::Error>

Performs the conversion.