Struct twitch_irc::message::NoticeMessage

pub struct NoticeMessage {
    pub channel_login: Option<String>,
    pub message_text: String,
    pub message_id: Option<String>,
    pub source: IRCMessage,
}

A user-facing notice sent by the server.

Fields

channel_login: Option<String>

The login name of the channel that this notice was sent to. There are cases where this is missing, for example when a NOTICE message is sent in response to a failed login attempt.

message_text: String

Message content of the notice. This is some user-friendly string, e.g. You are permanently banned from talking in <channel>.

message_id: Option<String>

If present, a computer-readable string identifying the class/type of notice. For example msg_banned. These message IDs are documented by Twitch here.

source: IRCMessage

The message that this NoticeMessage was parsed from.

Trait Implementations

impl Clone for NoticeMessage

fn clone(&self) -> NoticeMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NoticeMessage

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

Formats the value using the given formatter.

impl From<NoticeMessage> for IRCMessage

fn from(msg: NoticeMessage) -> IRCMessage

Performs the conversion.

impl PartialEq<NoticeMessage> for NoticeMessage

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

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

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

This method tests for !=.

impl StructuralPartialEq for NoticeMessage

impl TryFrom<IRCMessage> for NoticeMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.