Struct Message

#[non_exhaustive]
pub struct Message<P> {
    pub join_reference: Option<String>,
    pub message_reference: String,
    pub topic_name: String,
    pub event_name: String,
    pub payload: P,
}

Message received from the channel.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

join_reference: Option<String>

The join_reference is also chosen by the client and should also be a unique value.

It only needs to be sent for a phx_join event; for other messages it can be null. It is used as a message reference for push messages from the server, meaning those that are not replies to a specific client message. For example, imagine something like “a new user just joined the chat room”.

message_reference: String

The message_reference is chosen by the client and should be a unique value.

The server includes it in its reply so that the client knows which message the reply is for.

topic_name: String

The topic_name must be a known topic for the socket endpoint, and a client must join that topic before sending any messages on it.

event_name: String

The event_name must match the first argument of a handle_in function on the server channel module.

payload: P

The payload should be a map and is passed as the second argument to that handle_in function.

Trait Implementations

impl<P: Clone> Clone for Message<P>

fn clone(&self) -> Message<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Debug> Debug for Message<P>

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

Formats the value using the given formatter.

impl<P> Display for Message<P>

where P: Serialize + Debug,

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

Formats the value using the given formatter.

impl<P: PartialEq> PartialEq for Message<P>

fn eq(&self, other: &Message<P>) -> 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<P: Eq> Eq for Message<P>

impl<P> StructuralPartialEq for Message<P>