Struct Response 

pub struct Response {
    pub id: RequestId,
    pub response_type: ResponseType,
    pub result: Option<Value>,
    pub error: Option<String>,
    pub message: Option<String>,
}

A response from remote end to local end.

Format

Success:

{
  "id": "uuid",
  "type": "success",
  "result": { ... }
}

Error:

{
  "id": "uuid",
  "type": "error",
  "error": "error code",
  "message": "error message"
}

Fields

id: RequestId

Matches the command id.

response_type: ResponseType

Response type.

result: Option<Value>

Result data (if success).

error: Option<String>

Error code (if error).

message: Option<String>

Error message (if error).

Implementations

impl Response

pub fn is_success(&self) -> bool

Returns true if this is a success response.

pub fn is_error(&self) -> bool

Returns true if this is an error response.

pub fn into_result(self) -> Result<Value>

Extracts the result value, returning error if response was error.

Errors

Returns Error::Protocol if the response was an error.

pub fn get_string(&self, key: &str) -> String

Gets a string value from the result.

Returns empty string if key not found or not a string.

pub fn get_u64(&self, key: &str) -> u64

Gets a u64 value from the result.

Returns 0 if key not found or not a number.

pub fn get_bool(&self, key: &str) -> bool

Gets a boolean value from the result.

Returns false if key not found or not a boolean.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Response

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.