[−][src]Struct twitch_irc::message::IRCMessage

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

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

`impl IRCMessage`[src]

`pub fn new_simple(command: String, params: Vec<String>) -> IRCMessage`[src]

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

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

Create a new IRCMessage by specifying all fields.

`pub fn parse(mut source: &str) -> Result<IRCMessage, IRCParseError>`[src]

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

Trait Implementations

`impl AsRawIRC for IRCMessage`[src]

`pub fn format_as_raw_irc(&self, f: &mut Formatter<'_>) -> Result`[src]

`pub fn as_raw_irc(&self) -> String where Self: Sized,` [src]

`impl Clone for IRCMessage`[src]

`pub fn clone(&self) -> IRCMessage`[src]

`pub fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for IRCMessage`[src]

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

`impl From<ClearChatMessage> for IRCMessage`[src]

`pub fn from(msg: ClearChatMessage) -> IRCMessage`[src]

`impl From<ClearMsgMessage> for IRCMessage`[src]

`pub fn from(msg: ClearMsgMessage) -> IRCMessage`[src]

`impl From<GlobalUserStateMessage> for IRCMessage`[src]

`pub fn from(msg: GlobalUserStateMessage) -> IRCMessage`[src]

`impl From<HostTargetMessage> for IRCMessage`[src]

`pub fn from(msg: HostTargetMessage) -> IRCMessage`[src]

`impl From<JoinMessage> for IRCMessage`[src]

`pub fn from(msg: JoinMessage) -> IRCMessage`[src]

`impl From<NoticeMessage> for IRCMessage`[src]

`pub fn from(msg: NoticeMessage) -> IRCMessage`[src]

`impl From<PartMessage> for IRCMessage`[src]

`pub fn from(msg: PartMessage) -> IRCMessage`[src]

`impl From<PingMessage> for IRCMessage`[src]

`pub fn from(msg: PingMessage) -> IRCMessage`[src]

`impl From<PongMessage> for IRCMessage`[src]

`pub fn from(msg: PongMessage) -> IRCMessage`[src]

`impl From<PrivmsgMessage> for IRCMessage`[src]

`pub fn from(msg: PrivmsgMessage) -> IRCMessage`[src]

`impl From<ReconnectMessage> for IRCMessage`[src]

`pub fn from(msg: ReconnectMessage) -> IRCMessage`[src]

`impl From<RoomStateMessage> for IRCMessage`[src]

`pub fn from(msg: RoomStateMessage) -> IRCMessage`[src]

`impl From<ServerMessage> for IRCMessage`[src]

`pub fn from(msg: ServerMessage) -> IRCMessage`[src]

`impl From<ServerMessageParseError> for IRCMessage`[src]

`pub fn from(msg: ServerMessageParseError) -> IRCMessage`[src]

`impl From<UserNoticeMessage> for IRCMessage`[src]

`pub fn from(msg: UserNoticeMessage) -> IRCMessage`[src]

`impl From<UserStateMessage> for IRCMessage`[src]

`pub fn from(msg: UserStateMessage) -> IRCMessage`[src]

`impl From<WhisperMessage> for IRCMessage`[src]

`pub fn from(msg: WhisperMessage) -> IRCMessage`[src]

`impl PartialEq<IRCMessage> for IRCMessage`[src]

`pub fn eq(&self, other: &IRCMessage) -> bool`[src]

`pub fn ne(&self, other: &IRCMessage) -> bool`[src]

`impl StructuralPartialEq for IRCMessage`[src]

`impl TryFrom<IRCMessage> for ClearChatMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<ClearChatMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for ClearMsgMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<ClearMsgMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for ReconnectMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<ReconnectMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for RoomStateMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<RoomStateMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for UserNoticeMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<UserNoticeMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for UserStateMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<UserStateMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for WhisperMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<WhisperMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for ServerMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<ServerMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for GlobalUserStateMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<GlobalUserStateMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for HostTargetMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<HostTargetMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for JoinMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<JoinMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for NoticeMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<NoticeMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for PartMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<PartMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for PingMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<PingMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for PongMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<PongMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for PrivmsgMessage`[src]

`type Error = ServerMessageParseError`

The type returned in the event of a conversion error.

`pub fn try_from( source: IRCMessage ) -> Result<PrivmsgMessage, ServerMessageParseError>`[src]

Auto Trait Implementations

`impl RefUnwindSafe for IRCMessage`[src]

`impl Send for IRCMessage`[src]

`impl Sync for IRCMessage`[src]

`impl Unpin for IRCMessage`[src]

`impl UnwindSafe for IRCMessage`[src]

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T> Instrument for T`[src]

`pub fn instrument(self, span: Span) -> Instrumented<Self>`[src]

`pub fn in_current_span(self) -> Instrumented<Self>`[src]

`impl<T> Instrument for T`[src]

`pub fn instrument(self, span: Span) -> Instrumented<Self>`[src]

`pub fn in_current_span(self) -> Instrumented<Self>`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T> Same<T> for T`

`type Output = T`

Should always be Self

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`pub fn to_owned(&self) -> T`[src]

`pub fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

[−][src]Struct twitch_irc::message::IRCMessage

Fields

Implementations

impl IRCMessage[src]

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

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

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

Trait Implementations

impl AsRawIRC for IRCMessage[src]

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

pub fn as_raw_irc(&self) -> String where Self: Sized, [src]

impl Clone for IRCMessage[src]

pub fn clone(&self) -> IRCMessage[src]

pub fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for IRCMessage[src]

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

impl From<ClearChatMessage> for IRCMessage[src]

pub fn from(msg: ClearChatMessage) -> IRCMessage[src]

impl From<ClearMsgMessage> for IRCMessage[src]

pub fn from(msg: ClearMsgMessage) -> IRCMessage[src]

impl From<GlobalUserStateMessage> for IRCMessage[src]

pub fn from(msg: GlobalUserStateMessage) -> IRCMessage[src]

impl From<HostTargetMessage> for IRCMessage[src]

pub fn from(msg: HostTargetMessage) -> IRCMessage[src]

impl From<JoinMessage> for IRCMessage[src]

pub fn from(msg: JoinMessage) -> IRCMessage[src]

impl From<NoticeMessage> for IRCMessage[src]

pub fn from(msg: NoticeMessage) -> IRCMessage[src]

impl From<PartMessage> for IRCMessage[src]

pub fn from(msg: PartMessage) -> IRCMessage[src]

impl From<PingMessage> for IRCMessage[src]

pub fn from(msg: PingMessage) -> IRCMessage[src]

impl From<PongMessage> for IRCMessage[src]

pub fn from(msg: PongMessage) -> IRCMessage[src]

impl From<PrivmsgMessage> for IRCMessage[src]

pub fn from(msg: PrivmsgMessage) -> IRCMessage[src]

impl From<ReconnectMessage> for IRCMessage[src]

pub fn from(msg: ReconnectMessage) -> IRCMessage[src]

impl From<RoomStateMessage> for IRCMessage[src]

pub fn from(msg: RoomStateMessage) -> IRCMessage[src]

impl From<ServerMessage> for IRCMessage[src]

pub fn from(msg: ServerMessage) -> IRCMessage[src]

impl From<ServerMessageParseError> for IRCMessage[src]

pub fn from(msg: ServerMessageParseError) -> IRCMessage[src]

impl From<UserNoticeMessage> for IRCMessage[src]

pub fn from(msg: UserNoticeMessage) -> IRCMessage[src]

impl From<UserStateMessage> for IRCMessage[src]

pub fn from(msg: UserStateMessage) -> IRCMessage[src]

impl From<WhisperMessage> for IRCMessage[src]

pub fn from(msg: WhisperMessage) -> IRCMessage[src]

impl PartialEq<IRCMessage> for IRCMessage[src]

pub fn eq(&self, other: &IRCMessage) -> bool[src]

pub fn ne(&self, other: &IRCMessage) -> bool[src]

impl StructuralPartialEq for IRCMessage[src]

impl TryFrom<IRCMessage> for ClearChatMessage[src]

type Error = ServerMessageParseError

pub fn try_from( source: IRCMessage) -> Result<ClearChatMessage, ServerMessageParseError>[src]

impl TryFrom<IRCMessage> for ClearMsgMessage[src]

type Error = ServerMessageParseError

pub fn try_from( source: IRCMessage) -> Result<ClearMsgMessage, ServerMessageParseError>[src]

impl TryFrom<IRCMessage> for ReconnectMessage[src]

type Error = ServerMessageParseError

pub fn try_from( source: IRCMessage) -> Result<ReconnectMessage, ServerMessageParseError>[src]

impl TryFrom<IRCMessage> for RoomStateMessage[src]

type Error = ServerMessageParseError

pub fn try_from( source: IRCMessage) -> Result<RoomStateMessage, ServerMessageParseError>[src]

impl TryFrom<IRCMessage> for UserNoticeMessage[src]

type Error = ServerMessageParseError

pub fn try_from( source: IRCMessage) -> Result<UserNoticeMessage, ServerMessageParseError>[src]

impl TryFrom<IRCMessage> for UserStateMessage[src]

type Error = ServerMessageParseError

pub fn try_from( source: IRCMessage) -> Result<UserStateMessage, ServerMessageParseError>[src]

impl TryFrom<IRCMessage> for WhisperMessage[src]

type Error = ServerMessageParseError

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

impl TryFrom<IRCMessage> for ServerMessage[src]

type Error = ServerMessageParseError

pub fn try_from( source: IRCMessage) -> Result<ServerMessage, ServerMessageParseError>[src]

impl TryFrom<IRCMessage> for GlobalUserStateMessage[src]

type Error = ServerMessageParseError

`impl IRCMessage`[src]

`pub fn new_simple(command: String, params: Vec<String>) -> IRCMessage`[src]

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

`pub fn parse(mut source: &str) -> Result<IRCMessage, IRCParseError>`[src]

`impl AsRawIRC for IRCMessage`[src]

`pub fn format_as_raw_irc(&self, f: &mut Formatter<'_>) -> Result`[src]

`pub fn as_raw_irc(&self) -> String where Self: Sized,` [src]

`impl Clone for IRCMessage`[src]

`pub fn clone(&self) -> IRCMessage`[src]

`pub fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for IRCMessage`[src]

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

`impl From<ClearChatMessage> for IRCMessage`[src]

`pub fn from(msg: ClearChatMessage) -> IRCMessage`[src]

`impl From<ClearMsgMessage> for IRCMessage`[src]

`pub fn from(msg: ClearMsgMessage) -> IRCMessage`[src]

`impl From<GlobalUserStateMessage> for IRCMessage`[src]

`pub fn from(msg: GlobalUserStateMessage) -> IRCMessage`[src]

`impl From<HostTargetMessage> for IRCMessage`[src]

`pub fn from(msg: HostTargetMessage) -> IRCMessage`[src]

`impl From<JoinMessage> for IRCMessage`[src]

`pub fn from(msg: JoinMessage) -> IRCMessage`[src]

`impl From<NoticeMessage> for IRCMessage`[src]

`pub fn from(msg: NoticeMessage) -> IRCMessage`[src]

`impl From<PartMessage> for IRCMessage`[src]

`pub fn from(msg: PartMessage) -> IRCMessage`[src]

`impl From<PingMessage> for IRCMessage`[src]

`pub fn from(msg: PingMessage) -> IRCMessage`[src]

`impl From<PongMessage> for IRCMessage`[src]

`pub fn from(msg: PongMessage) -> IRCMessage`[src]

`impl From<PrivmsgMessage> for IRCMessage`[src]

`pub fn from(msg: PrivmsgMessage) -> IRCMessage`[src]

`impl From<ReconnectMessage> for IRCMessage`[src]

`pub fn from(msg: ReconnectMessage) -> IRCMessage`[src]

`impl From<RoomStateMessage> for IRCMessage`[src]

`pub fn from(msg: RoomStateMessage) -> IRCMessage`[src]

`impl From<ServerMessage> for IRCMessage`[src]

`pub fn from(msg: ServerMessage) -> IRCMessage`[src]

`impl From<ServerMessageParseError> for IRCMessage`[src]

`pub fn from(msg: ServerMessageParseError) -> IRCMessage`[src]

`impl From<UserNoticeMessage> for IRCMessage`[src]

`pub fn from(msg: UserNoticeMessage) -> IRCMessage`[src]

`impl From<UserStateMessage> for IRCMessage`[src]

`pub fn from(msg: UserStateMessage) -> IRCMessage`[src]

`impl From<WhisperMessage> for IRCMessage`[src]

`pub fn from(msg: WhisperMessage) -> IRCMessage`[src]

`impl PartialEq<IRCMessage> for IRCMessage`[src]

`pub fn eq(&self, other: &IRCMessage) -> bool`[src]

`pub fn ne(&self, other: &IRCMessage) -> bool`[src]

`impl StructuralPartialEq for IRCMessage`[src]

`impl TryFrom<IRCMessage> for ClearChatMessage`[src]

`type Error = ServerMessageParseError`

`pub fn try_from( source: IRCMessage ) -> Result<ClearChatMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for ClearMsgMessage`[src]

`type Error = ServerMessageParseError`

`pub fn try_from( source: IRCMessage ) -> Result<ClearMsgMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for ReconnectMessage`[src]

`type Error = ServerMessageParseError`

`pub fn try_from( source: IRCMessage ) -> Result<ReconnectMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for RoomStateMessage`[src]

`type Error = ServerMessageParseError`

`pub fn try_from( source: IRCMessage ) -> Result<RoomStateMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for UserNoticeMessage`[src]

`type Error = ServerMessageParseError`

`pub fn try_from( source: IRCMessage ) -> Result<UserNoticeMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for UserStateMessage`[src]

`type Error = ServerMessageParseError`

`pub fn try_from( source: IRCMessage ) -> Result<UserStateMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for WhisperMessage`[src]

`type Error = ServerMessageParseError`

`pub fn try_from( source: IRCMessage ) -> Result<WhisperMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for ServerMessage`[src]

`type Error = ServerMessageParseError`

`pub fn try_from( source: IRCMessage ) -> Result<ServerMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for GlobalUserStateMessage`[src]

`type Error = ServerMessageParseError`

`pub fn try_from( source: IRCMessage ) -> Result<GlobalUserStateMessage, ServerMessageParseError>`[src]

`impl TryFrom<IRCMessage> for HostTargetMessage`[src]

`type Error = ServerMessageParseError`

`pub fn try_from( source: IRCMessage ) -> Result<HostTargetMessage, ServerMessageParseError>`[src]