Struct Response

pub struct Response {
    pub request_seq: i64,
    pub success: bool,
    pub message: Option<String>,
    pub body: Option<Value>,
}

Represents response to the client.

The command field (which is a string) is used as a tag in the ResponseBody enum, so users of this crate will control it by selecting the appropriate enum variant for the body.

There is also no separate ErrorResponse struct. Instead, Error is just a variant of the ResponseBody enum.

Specification: Response

Fields

request_seq: i64

Sequence number of the corresponding request.

success: bool

Outcome of the request. If true, the request was successful and the body attribute may contain the result of the request. If the value is false, the attribute message contains the error in short form and the body may contain additional information (see ErrorResponse.body.error).

message: Option<String>

Contains the raw error in short form if success is false. This raw error might be interpreted by the client and is not shown in the UI. Some predefined values exist. Values: ‘cancelled’: request was cancelled. etc.

body: Option<Value>

Contains request result if success is true and error details if success is false.

Implementations

impl Response

pub fn new( request_seq: i64, success: bool, message: Option<String>, body: Option<impl Serialize>, ) -> Response

Creates a new response.

pub fn success(request_seq: i64, body: impl Serialize) -> Response

Creates a new successful response.

pub fn error( request_seq: i64, message: Option<String>, detail: Option<Message>, ) -> Response

Creates a new error response.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl Default for Response

fn default() -> Response

Returns the “default value” for a type.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Response, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Response> for Message

fn from(resp: Response) -> Self

Converts to this type from the input type.

impl From<Response> for Message

fn from(response: Response) -> Message

Converts to this type from the input type.

impl Serialize for Response

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.