Struct ApiResponse 

pub struct ApiResponse<T> {
    pub code: i32,
    pub msg: String,
    pub data: Option<T>,
    pub aggregated_error: Option<HashMap<String, AggregatedItemError>>,
}

Generic API response wrapper

Fields

code: i32

msg: String

data: Option<T>

aggregated_error: Option<HashMap<String, AggregatedItemError>>

Per-item failures for batch operations, keyed by the URI that was sent.

Only present when the operation partially failed (see CODE_BATCH_OPERATION_NOT_FULLY_COMPLETED). Items that succeeded are absent from the map, so the successful set is the request’s URIs minus these keys.

Implementations

impl ApiResponse<Value>

pub fn into_error(self) -> Error

Convert a non-zero response into the most informative error variant.

Folding every failure into Error::Api would discard exactly what callers need to act on: which items of a batch failed, and the unlock tokens behind a lock conflict. Endpoints that can return either should route their errors through here.

Trait Implementations

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.