Struct agde::Message

pub struct Message { /* private fields */ }

A message to be communicated between clients.

Contains a MessageKind, sender UUID, and message UUID.

Implementations

impl Message

pub fn new(inner: MessageKind, sender: Uuid, uuid: Uuid) -> Self

Creates a new message.

pub fn sender(&self) -> Uuid

Get the sender UUID.

pub fn uuid(&self) -> Uuid

Get the message UUID.

pub fn inner(&self) -> &MessageKind

Get the inner MessageKind.

This contains all the data of the message.

pub fn inner_mut(&mut self) -> &mut MessageKind

Get a mutable reference to the inner MessageKind.

This contains all the data of the message.

pub fn into_inner(self) -> MessageKind

Get the inner MessageKind.

This contains all the data of the message.

pub fn recipient(&self) -> Recipient

Get the specific recipient if the MessageKind is targeted.

Can be used to determine to send this message to only one pier or all.

pub fn to_bin(&self) -> Vec<u8>

Converts the message to bytes.

You can also use bincode or any other serde-based library to serialize the message.

pub fn from_bin(slice: &[u8]) -> Result<Self, DecodeError>

Errors

Returns an appropriate error if the deserialisation failed.

pub fn to_base64(&self) -> String

Converts the message to a plain text compatible encoding, namely Base64.

This is a optimised version of converting Self::to_bin() to Base64. Since I’m using readers and writers, less allocations are needed.

pub fn from_base64(string: &str) -> Result<Self, DecodeError>

Errors

Returns an appropriate error if the deserialisation failed. If the Base64 encoding is wrong, the error returned is bincode::error::DecodeError::OtherString which (always) starts with base64 decoding failed.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Message

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Message> for Message

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Message

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

Serialize this value into the given Serde serializer.

impl Eq for Message

impl StructuralEq for Message

impl StructuralPartialEq for Message