Struct SocketMessage

pub struct SocketMessage {
    pub sender_name: Option<String>,
    pub sender_type: Option<String>,
    pub message: String,
    pub message_type: SocketMessageType,
}

Represents a message sent from the game

Fields

sender_name: Option<String>

The name of the sender, usually the name of the mod

sender_type: Option<String>

The type of the sender, usually ModHelper

message: String

The message sent from the game

message_type: SocketMessageType

The type of message sent from the game Note that the message sent calls this type so we have to alias it because type is a reserved keyword

Implementations

impl SocketMessage

pub fn make_internal(message: &str, message_type: SocketMessageType) -> Self

Make an internal SocketMessage to send to the server for debugging/information.

Returns

A SocketMessage with sender_name set to “Manager” and sender_type set to “Log Server”.

Trait Implementations

impl Clone for SocketMessage

fn clone(&self) -> SocketMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SocketMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SocketMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SocketMessage

fn eq(&self, other: &SocketMessage) -> 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 Searchable for SocketMessage

fn get_values(&self) -> Vec<String>

Get the values that can be searched Each value will be weighted based on its position in the list (first is most important) Values are automatically normalized for optimal searching via normalize_value when using search_list

fn break_tie(&self, _other: &Self) -> Ordering

In the event two items have the same score, this function will be called to break the tie

impl Serialize for SocketMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SocketMessage