Struct Message

pub struct Message {
    pub cmd_id: CommandId,
    pub request_id: String,
    pub payload: Option<Bytes>,
}

The unit of the protocol built on top of TCP that this server uses.

Fields

cmd_id: CommandId

Used as a way of identifying the format of the payload for deserialization

request_id: String

A unique request identifier - used for request tracing and debugging Note that this has to be encoded as utf8 otherwise parsing the message will fail

payload: Option<Bytes>

the Request payload

Implementations

impl Message

pub fn new( cmd_id: CommandId, request_id: String, payload: Option<Bytes>, ) -> Self

Constructs a new Message with the given id and payload

pub async fn try_from_async_read<R: AsyncRead + Unpin>( reader: &mut R, ) -> Result<Self>

This function tries to construct a Message by reading bytes from the provided AsyncRead source

Errors

This functions returns errors in the following cases

1. The message size is bigger than MAX_MESSAGE_SIZE
2. The message is somehow malformed (eg: less bytes were provided than the length received)

pub fn serialize(self) -> Bytes

Serializes a Message struct into it’s serialized format (see top level comment for format)

Trait Implementations

impl Debug for Message

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

Formats the value using the given formatter.

impl<M: IntoMessage> From<M> for Message

fn from(v: M) -> Self

Converts to this type from the input type.