Struct NetworkMessage

pub struct NetworkMessage<T: NetworkContent> {
    pub to: Arc<String>,
    pub from: Arc<String>,
    pub id: Arc<String>,
    pub reply: Option<Arc<String>>,
    pub content: T,
}

This struct represents the network messages sent and received, it can be created either from the new new constructor if a fresh message is desired. If a reply is desired then the reply method should be used.

Fields

to: Arc<String>

The receiver id, this is currently a string but this may change to a generic representing an id in the future

from: Arc<String>

The sender id, this is currently a string but this may change to a generic representing an id in the future

id: Arc<String>

The message id, used to reply to this message

reply: Option<Arc<String>>

If this is set to Some then this message is a reply to the contained ID, else it is a fresh message

content: T

The content of the message

Implementations

impl<T: NetworkContent> NetworkMessage<T>

pub fn new(to: Arc<String>, from: Arc<String>, content: T) -> Self

Create a new fresh message

pub fn reply(&self, content: T) -> Self

Used to construct replies to the provided message.

Trait Implementations

impl<T: Clone + NetworkContent> Clone for NetworkMessage<T>

fn clone(&self) -> NetworkMessage<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + NetworkContent> Debug for NetworkMessage<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for NetworkMessage<T>

where T: DeserializeOwned + NetworkContent,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Hash + NetworkContent> Hash for NetworkMessage<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord + NetworkContent> Ord for NetworkMessage<T>

fn cmp(&self, other: &NetworkMessage<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq + NetworkContent> PartialEq for NetworkMessage<T>

fn eq(&self, other: &NetworkMessage<T>) -> 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<T: PartialOrd + NetworkContent> PartialOrd for NetworkMessage<T>

fn partial_cmp(&self, other: &NetworkMessage<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for NetworkMessage<T>

where T: Serialize + NetworkContent,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq + NetworkContent> Eq for NetworkMessage<T>

impl<T: NetworkContent> StructuralPartialEq for NetworkMessage<T>