Struct irc_async::proto::message::Message

pub struct Message {
    pub tags: Option<Vec<Tag>>,
    pub prefix: Option<String>,
    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<String>

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.

Methods

impl Message

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

Creates a new message from the given components.

Example

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

pub fn with_tags(
    tags: Option<Vec<Tag>>,
    prefix: Option<&str>,
    command: &str,
    args: Vec<&str>,
    suffix: Option<&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"], None
).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"], Some("Hi, everyone!")
).unwrap();
assert_eq!(msg1.response_target(), Some("#channel"));
let msg2 = Message::new(
    Some("ada"), "PRIVMSG", vec!["betsy"], Some("betsy: hi")
).unwrap();
assert_eq!(msg2.response_target(), Some("ada"));

pub fn as_string(&self) -> String

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

Example

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

Trait Implementations

impl From<Command> for Message

fn from(cmd: Command) -> Message

Performs the conversion.

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

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

Performs the conversion.

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 PartialEq<Message> 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: &Message) -> bool

This method tests for !=.

impl Debug for Message

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

Formats the value using the given formatter.

impl Display for Message

fn fmt(&self, f: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl FromStr for Message

type Err = IrcError

The associated error which can be returned from parsing.

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

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

impl StructuralPartialEq for Message