Struct twitch_irc::message::WhisperMessage

pub struct WhisperMessage {
    pub recipient_login: String,
    pub sender: TwitchUserBasics,
    pub message_text: String,
    pub name_color: Option<RGBColor>,
    pub badges: Vec<Badge>,
    pub emotes: Vec<Emote>,
    pub source: IRCMessage,
}

A incoming whisper message (a private user-to-user message).

Fields

recipient_login: String

The login name of the receiving user (the logged in user).

sender: TwitchUserBasics

User details of the user that sent us this whisper (the sending user).

message_text: String

The text content of the message.

name_color: Option<RGBColor>

Name color of the sending user.

badges: Vec<Badge>

List of badges (that the sending user has) that should be displayed alongside the message.

emotes: Vec<Emote>

A list of emotes in this message. Each emote replaces a part of the message_text. These emotes are sorted in the order that they appear in the message.

source: IRCMessage

The message that this WhisperMessage was parsed from.

Trait Implementations

impl Clone for WhisperMessage

pub fn clone(&self) -> WhisperMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WhisperMessage

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

Formats the value using the given formatter.

impl From<WhisperMessage> for IRCMessage

pub fn from(msg: WhisperMessage) -> IRCMessage

Performs the conversion.

impl PartialEq<WhisperMessage> for WhisperMessage

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

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

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

This method tests for !=.

impl StructuralPartialEq for WhisperMessage

impl TryFrom<IRCMessage> for WhisperMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

pub fn try_from(
    source: IRCMessage
) -> Result<WhisperMessage, ServerMessageParseError>

Performs the conversion.