twitch_irc::message

Struct IRCMessage

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§

impl IRCMessage

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.

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

Create a new IRCMessage by specifying all fields.

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§

impl AsRawIRC for IRCMessage

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

Writes the raw IRC message to the given formatter.

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

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

impl Clone for IRCMessage

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

impl Debug for IRCMessage

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

Formats the value using the given formatter. Read more

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

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

Deserialize this value from the given Serde deserializer. Read more

impl From<ClearChatMessage> for IRCMessage

fn from(msg: ClearChatMessage) -> IRCMessage

Converts to this type from the input type.

impl From<ClearMsgMessage> for IRCMessage

fn from(msg: ClearMsgMessage) -> IRCMessage

Converts to this type from the input type.

impl From<GlobalUserStateMessage> for IRCMessage

fn from(msg: GlobalUserStateMessage) -> IRCMessage

Converts to this type from the input type.

impl From<JoinMessage> for IRCMessage

fn from(msg: JoinMessage) -> IRCMessage

Converts to this type from the input type.

impl From<NoticeMessage> for IRCMessage

fn from(msg: NoticeMessage) -> IRCMessage

Converts to this type from the input type.

impl From<PartMessage> for IRCMessage

fn from(msg: PartMessage) -> IRCMessage

Converts to this type from the input type.

impl From<PingMessage> for IRCMessage

fn from(msg: PingMessage) -> IRCMessage

Converts to this type from the input type.

impl From<PongMessage> for IRCMessage

fn from(msg: PongMessage) -> IRCMessage

Converts to this type from the input type.

impl From<PrivmsgMessage> for IRCMessage

fn from(msg: PrivmsgMessage) -> IRCMessage

Converts to this type from the input type.

impl From<ReconnectMessage> for IRCMessage

fn from(msg: ReconnectMessage) -> IRCMessage

Converts to this type from the input type.

impl From<RoomStateMessage> for IRCMessage

fn from(msg: RoomStateMessage) -> IRCMessage

Converts to this type from the input type.

impl From<ServerMessage> for IRCMessage

fn from(msg: ServerMessage) -> IRCMessage

Converts to this type from the input type.

impl From<ServerMessageParseError> for IRCMessage

fn from(msg: ServerMessageParseError) -> IRCMessage

Converts to this type from the input type.

impl From<UserNoticeMessage> for IRCMessage

fn from(msg: UserNoticeMessage) -> IRCMessage

Converts to this type from the input type.

impl From<UserStateMessage> for IRCMessage

fn from(msg: UserStateMessage) -> IRCMessage

Converts to this type from the input type.

impl From<WhisperMessage> for IRCMessage

fn from(msg: WhisperMessage) -> IRCMessage

Converts to this type from the input type.

impl PartialEq for IRCMessage

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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 Serialize for IRCMessage

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

Serialize this value into the given Serde serializer. Read more

impl TryFrom<IRCMessage> for ClearChatMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<IRCMessage> for ClearMsgMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<IRCMessage> for GlobalUserStateMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<IRCMessage> for JoinMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

impl TryFrom<IRCMessage> for PartMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<IRCMessage> for PingMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<IRCMessage> for PongMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<IRCMessage> for PrivmsgMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<IRCMessage> for ReconnectMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<IRCMessage> for RoomStateMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<IRCMessage> for ServerMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<IRCMessage> for UserNoticeMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<IRCMessage> for UserStateMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<IRCMessage> for WhisperMessage

type Error = ServerMessageParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for IRCMessage

impl StructuralPartialEq for IRCMessage

Auto Trait Implementations§

impl Freeze for IRCMessage

impl RefUnwindSafe for IRCMessage

impl Send for IRCMessage

impl Sync for IRCMessage

impl Unpin for IRCMessage

impl UnwindSafe for IRCMessage

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

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

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

Checks if this value is equivalent to the given key. Read more

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> MaybeSendSync for T