Struct fml::types::ApiResponse

pub struct ApiResponse<T> {
    pub error: Option<String>,
    pub data: Option<T>,
    pub unknown: HashMap<String, Value>,
}

An API Response

Fields

error: Option<String>

A potential API error.

Populated on error.

data: Option<T>

A potential response payload.

Populated if successful.

unknown: HashMap<String, Value>

Unknown data

Implementations

impl<T> ApiResponse<T>

pub fn is_error(&self) -> bool

Whether the response is an error.

This performs a check on the error field.

pub fn is_success(&self) -> bool

Whether the response is a success.

This performs a check on the data field.

pub fn is_valid_response(&self) -> bool

Checks whether the data contained is valid.

This looks to see if this is both an error and success or neither.

Trait Implementations

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> From<ApiResponse<T>> for FmlResult<T>

fn from(response: ApiResponse<T>) -> Self

Converts to this type from the input type.