Struct twitch_irc::message::IRCMessage

source · [−]

pub struct IRCMessage {
    pub tags: IRCTags,
    pub prefix: Option<IRCPrefix>,
    pub command: String,
    pub params: Vec<String>,
}

Expand description

A protocol-level IRC message, with arbitrary command, parameters, tags and prefix.

See RFC 2812, section 2.3.1 for the message format that this is based on. Further, this implements IRCv3 tags.

Fields

tags: IRCTags

A map of additional key-value tags on this message.

prefix: Option<IRCPrefix>

The “prefix” of this message, as defined by RFC 2812. Typically specifies the sending server and/or user.

command: String

A command like PRIVMSG or 001 (see RFC 2812 for the definition).

params: Vec<String>

A list of parameters on this IRC message. See RFC 2812 for the definition.

Middle parameters and trailing parameters are treated the same here, and as long as there are no spaces in the last parameter, there is no way to tell if that parameter was a middle or trailing parameter when it was parsed.

Implementations

source

impl IRCMessage

source

pub fn new_simple(command: String, params: Vec<String>) -> IRCMessage

Create a new IRCMessage with just a command and parameters, similar to the irc! macro.

source

pub fn new(
 tags: IRCTags,
 prefix: Option<IRCPrefix>,
 command: String,
 params: Vec<String>
) -> IRCMessage

Create a new IRCMessage by specifying all fields.

source

pub fn parse(source: &str) -> Result<IRCMessage, IRCParseError>

Parse a raw IRC wire-format message into an IRCMessage. source should be specified without trailing newline character(s).

Trait Implementations

source

impl AsRawIRC for IRCMessage

source

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

Writes the raw IRC message to the given formatter.

source

fn as_raw_irc(&self) -> Stringwhere
Self: Sized,

Creates a new string with the raw IRC message. Read more

source

impl Clone for IRCMessage

source

fn clone(&self) -> IRCMessage

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for IRCMessage

source

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

Formats the value using the given formatter. Read more

source

impl<'de> Deserialize<'de> for IRCMessage

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl From<ClearChatMessage> for IRCMessage

source

fn from(msg: ClearChatMessage) -> IRCMessage

Converts to this type from the input type.

source

impl From<ClearMsgMessage> for IRCMessage

source

fn from(msg: ClearMsgMessage) -> IRCMessage

Converts to this type from the input type.

source

impl From<GlobalUserStateMessage> for IRCMessage

source

fn from(msg: GlobalUserStateMessage) -> IRCMessage

Converts to this type from the input type.

source

impl From<JoinMessage> for IRCMessage

source

fn from(msg: JoinMessage) -> IRCMessage

Converts to this type from the input type.

source

impl From<NoticeMessage> for IRCMessage

source

fn from(msg: NoticeMessage) -> IRCMessage

Converts to this type from the input type.

source

impl From<PartMessage> for IRCMessage

source

fn from(msg: PartMessage) -> IRCMessage

Converts to this type from the input type.

source

impl From<PingMessage> for IRCMessage

source

fn from(msg: PingMessage) -> IRCMessage

Converts to this type from the input type.

source

impl From<PongMessage> for IRCMessage

source

fn from(msg: PongMessage) -> IRCMessage

Converts to this type from the input type.

source

impl From<PrivmsgMessage> for IRCMessage

source

fn from(msg: PrivmsgMessage) -> IRCMessage

Converts to this type from the input type.

source

impl From<ReconnectMessage> for IRCMessage

source

fn from(msg: ReconnectMessage) -> IRCMessage

Converts to this type from the input type.

source

impl From<RoomStateMessage> for IRCMessage

source

fn from(msg: RoomStateMessage) -> IRCMessage

Converts to this type from the input type.

source

impl From<ServerMessage> for IRCMessage

source

fn from(msg: ServerMessage) -> IRCMessage

Converts to this type from the input type.

source

impl From<ServerMessageParseError> for IRCMessage

source

fn from(msg: ServerMessageParseError) -> IRCMessage

Converts to this type from the input type.

source

impl From<UserNoticeMessage> for IRCMessage

source

fn from(msg: UserNoticeMessage) -> IRCMessage

Converts to this type from the input type.

source

impl From<UserStateMessage> for IRCMessage

source

fn from(msg: UserStateMessage) -> IRCMessage

Converts to this type from the input type.

source

impl From<WhisperMessage> for IRCMessage

source

fn from(msg: WhisperMessage) -> IRCMessage

Converts to this type from the input type.

source

impl PartialEq<IRCMessage> for IRCMessage

source

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

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl Serialize for IRCMessage

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl TryFrom<IRCMessage> for ClearChatMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<IRCMessage> for ClearMsgMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<IRCMessage> for GlobalUserStateMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<IRCMessage> for JoinMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<IRCMessage> for NoticeMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<IRCMessage> for PartMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<IRCMessage> for PingMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<IRCMessage> for PongMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<IRCMessage> for PrivmsgMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<IRCMessage> for ReconnectMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<IRCMessage> for RoomStateMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<IRCMessage> for ServerMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<IRCMessage> for UserNoticeMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<IRCMessage> for UserStateMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<IRCMessage> for WhisperMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl Eq for IRCMessage

source

impl StructuralEq for IRCMessage

source

impl StructuralPartialEq for IRCMessage

Auto Trait Implementations

impl RefUnwindSafe for IRCMessage

impl Send for IRCMessage

impl Sync for IRCMessage

impl Unpin for IRCMessage

impl UnwindSafe for IRCMessage

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

source

Struct twitch_irc::message::IRCMessage

Fields

Implementations

impl IRCMessage

pub fn new_simple(command: String, params: Vec<String>) -> IRCMessage

pub fn new( tags: IRCTags, prefix: Option<IRCPrefix>, command: String, params: Vec<String>) -> IRCMessage

pub fn parse(source: &str) -> Result<IRCMessage, IRCParseError>

Trait Implementations

impl AsRawIRC for IRCMessage

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

fn as_raw_irc(&self) -> Stringwhere Self: Sized,

impl Clone for IRCMessage

fn clone(&self) -> IRCMessage

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

impl Debug for IRCMessage

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

impl<'de> Deserialize<'de> for IRCMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

impl From<ClearChatMessage> for IRCMessage

fn from(msg: ClearChatMessage) -> IRCMessage

impl From<ClearMsgMessage> for IRCMessage

fn from(msg: ClearMsgMessage) -> IRCMessage

impl From<GlobalUserStateMessage> for IRCMessage

fn from(msg: GlobalUserStateMessage) -> IRCMessage

impl From<JoinMessage> for IRCMessage

fn from(msg: JoinMessage) -> IRCMessage

impl From<NoticeMessage> for IRCMessage

fn from(msg: NoticeMessage) -> IRCMessage

impl From<PartMessage> for IRCMessage

fn from(msg: PartMessage) -> IRCMessage

impl From<PingMessage> for IRCMessage

fn from(msg: PingMessage) -> IRCMessage

impl From<PongMessage> for IRCMessage

fn from(msg: PongMessage) -> IRCMessage

impl From<PrivmsgMessage> for IRCMessage

fn from(msg: PrivmsgMessage) -> IRCMessage

impl From<ReconnectMessage> for IRCMessage

fn from(msg: ReconnectMessage) -> IRCMessage

impl From<RoomStateMessage> for IRCMessage

fn from(msg: RoomStateMessage) -> IRCMessage

impl From<ServerMessage> for IRCMessage

fn from(msg: ServerMessage) -> IRCMessage

impl From<ServerMessageParseError> for IRCMessage

fn from(msg: ServerMessageParseError) -> IRCMessage

impl From<UserNoticeMessage> for IRCMessage

fn from(msg: UserNoticeMessage) -> IRCMessage

impl From<UserStateMessage> for IRCMessage

fn from(msg: UserStateMessage) -> IRCMessage

impl From<WhisperMessage> for IRCMessage

fn from(msg: WhisperMessage) -> IRCMessage

impl PartialEq<IRCMessage> for IRCMessage

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

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

impl Serialize for IRCMessage

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

impl TryFrom<IRCMessage> for ClearChatMessage

type Error = ServerMessageParseError

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

impl TryFrom<IRCMessage> for ClearMsgMessage

type Error = ServerMessageParseError

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

impl TryFrom<IRCMessage> for GlobalUserStateMessage

type Error = ServerMessageParseError

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

impl TryFrom<IRCMessage> for JoinMessage

type Error = ServerMessageParseError

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

impl TryFrom<IRCMessage> for NoticeMessage

type Error = ServerMessageParseError

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

impl TryFrom<IRCMessage> for PartMessage

type Error = ServerMessageParseError

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

impl TryFrom<IRCMessage> for PingMessage

type Error = ServerMessageParseError

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

impl TryFrom<IRCMessage> for PongMessage

type Error = ServerMessageParseError

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

impl TryFrom<IRCMessage> for PrivmsgMessage

pub fn new(
tags: IRCTags,
prefix: Option<IRCPrefix>,
command: String,
params: Vec<String>
) -> IRCMessage

fn as_raw_irc(&self) -> Stringwhere
Self: Sized,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

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

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

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

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

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

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

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

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

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

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

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

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,