Struct RpcEnvelope 

pub struct RpcEnvelope {
    pub route_key: String,
    pub payload: Option<Bytes>,
    pub error: Option<ErrorResponse>,
    pub trace_id: String,
    pub request_id: String,
    pub metadata: Vec<MetadataEntry>,
    pub timeout_ms: i64,
}

RpcEnvelope wraps State Path RPC messages

Fields

route_key: String

Route key: “package.Service.Method”

payload: Option<Bytes>

Payload for successful RPC (request or response) Optional: when error is present, payload should be empty

error: Option<ErrorResponse>

System-level error (envelope layer) Examples: UnknownRoute, DeserializationError, Panic, InvalidStateTransition Business errors should be in the response message payload

trace_id: String

request_id: String

metadata: Vec<MetadataEntry>

timeout_ms: i64

Implementations

impl RpcEnvelope

pub fn payload(&self) -> &[u8]

Returns the value of payload, or the default value if payload is unset.

Trait Implementations

impl Clone for RpcEnvelope

fn clone(&self) -> RpcEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RpcEnvelope

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

Formats the value using the given formatter.

impl Default for RpcEnvelope

fn default() -> Self

Returns the “default value” for a type.

impl Message for RpcEnvelope

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RpcEnvelope

fn eq(&self, other: &RpcEnvelope) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RpcEnvelope