Struct irc::client::prelude::Message

pub struct Message {
    pub tags: Option<Vec<Tag>>,
    pub prefix: Option<Prefix>,
    pub command: Command,
}

A data structure representing an IRC message according to the protocol specification. It consists of a collection of IRCv3 tags, a prefix (describing the source of the message), and the protocol command. If the command is unknown, it is treated as a special raw command that consists of a collection of arguments and the special suffix argument. Otherwise, the command is parsed into a more useful form as described in Command.

Fields

tags: Option<Vec<Tag>>

Message tags as defined by IRCv3.2. These tags are used to add extended information to the given message, and are commonly used in IRCv3 extensions to the IRC protocol.

prefix: Option<Prefix>

The message prefix (or source) as defined by RFC 2812.

command: Command

The IRC command, parsed according to the known specifications. The command itself and its arguments (including the special suffix argument) are captured in this component.

Implementations

impl Message

pub fn new( prefix: Option<&str>, command: &str, args: Vec<&str> ) -> Result<Message, MessageParseError>

Creates a new message from the given components.

Example

let message = Message::new(
    Some("nickname!username@hostname"), "JOIN", vec!["#channel"]
).unwrap();

pub fn with_tags( tags: Option<Vec<Tag>>, prefix: Option<&str>, command: &str, args: Vec<&str> ) -> Result<Message, MessageParseError>

Creates a new IRCv3.2 message from the given components, including message tags. These tags are used to add extended information to the given message, and are commonly used in IRCv3 extensions to the IRC protocol.

pub fn source_nickname(&self) -> Option<&str>

Gets the nickname of the message source, if it exists.

Example

let message = Message::new(
    Some("nickname!username@hostname"), "JOIN", vec!["#channel"]
).unwrap();
assert_eq!(message.source_nickname(), Some("nickname"));

pub fn response_target(&self) -> Option<&str>

Gets the likely intended place to respond to this message. If the type of the message is a PRIVMSG or NOTICE and the message is sent to a channel, the result will be that channel. In all other cases, this will call source_nickname.

Example

let msg1 = Message::new(
    Some("ada"), "PRIVMSG", vec!["#channel", "Hi, everyone!"]
).unwrap();
assert_eq!(msg1.response_target(), Some("#channel"));
let msg2 = Message::new(
    Some("ada"), "PRIVMSG", vec!["betsy", "betsy: hi"]
).unwrap();
assert_eq!(msg2.response_target(), Some("ada"));

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Display for Message

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

Converts a Message into a String according to the IRC protocol.

Example

let msg = Message::new(
    Some("ada"), "PRIVMSG", vec!["#channel", "Hi, everyone!"]
).unwrap();
assert_eq!(msg.to_string(), ":ada PRIVMSG #channel :Hi, everyone!\r\n");

impl<'a> From<&'a str> for Message

fn from(s: &'a str) -> Message

Converts to this type from the input type.

impl From<Command> for Message

fn from(cmd: Command) -> Message

Converts to this type from the input type.

impl FromStr for Message

type Err = ProtocolError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Message, <Message as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for Message

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

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

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.

impl Sink<Message> for Connection

type Error = Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Message) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<T> Sink<Message> for Logged<T>

where T: Unpin + AsyncRead + AsyncWrite,

type Error = Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

fn start_send(self: Pin<&mut Self>, item: Message) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

impl<T> Sink<Message> for Transport<T>

where T: Unpin + AsyncRead + AsyncWrite,

type Error = Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Message) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl StructuralPartialEq for Message