Struct Response 

pub struct Response {
    pub msg_type: String,
    pub id: String,
    pub status: ResponseStatus,
    pub result: Option<Value>,
    pub error: Option<ResponseError>,
    pub meta: ResponseMeta,
}

Response message envelope.

Fields

msg_type: String

Message type, always “response”.

id: String

Request ID this response correlates to.

status: ResponseStatus

Response status.

result: Option<Value>

Result payload (for successful responses).

error: Option<ResponseError>

Error details (for error responses).

meta: ResponseMeta

Response metadata.

Implementations

impl Response

pub fn ok(id: impl Into<String>, result: Value) -> Self

Creates a successful response.

Examples

use rstmdb_protocol::{Response, ResponseError};
use rstmdb_protocol::ErrorCode;
use serde_json::json;

let ok = Response::ok("1", json!({"pong": true}));
assert!(ok.is_ok());

let err = Response::error("2", ResponseError::new(
    ErrorCode::NotFound, "not found",
));
assert!(err.is_error());

pub fn error(id: impl Into<String>, error: ResponseError) -> Self

pub fn with_meta(self, meta: ResponseMeta) -> Self

pub fn is_ok(&self) -> bool

pub fn is_error(&self) -> bool

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.

impl Serialize for Response

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

where __S: Serializer,

Serialize this value into the given Serde serializer.