Struct irc_rust::message::Message

pub struct Message { /* fields omitted */ }

A simple irc message containing tags, prefix, command, parameters and a trailing parameter.

Examples

Create a Message from a plain string.

use irc_rust::message::Message;

let message = Message::from("@key1=value1;key2=value2 :name!user@host CMD param1 param2 :trailing");

assert_eq!(message.to_string(), "@key1=value1;key2=value2 :name!user@host CMD param1 param2 :trailing");

To build a message in a verbose and easy to read way you can use the Message::builder method and the MessageBuilder.

use irc_rust::message::Message;

let message = Message::builder()
        .tag("key1", "value1")
        .tag("key2", "value2")
        .prefix_name("name")
        .prefix_user("user")
        .prefix_host("host")
        .command("CMD")
        .param("param1").param("param2")
        .trailing("trailing")
        .build();

let tags = message.tags().unwrap();
println!("key1={}", &tags["key1"]) // Prints 'key1=value1'

You can create a new message from an existing message by calling the to_builder method. To alter existing parameters the set_param method can be used.

use irc_rust::message::Message;

let message = Message::from("@key=value :name!user@host CMD param1 :trailing!").to_builder()
    .tag("key", "value2")
    .param("param2")
    .param("param4")
    .set_param(1, "param3")
    .build();
assert_eq!(message.to_string(), "@key=value2 :name!user@host CMD param1 param3 param4 :trailing!");

Implementations

impl Message

pub fn new(raw: String) -> Message

Create a new Message from the given string. Expects the string to be in a valid irc format.

pub fn from(raw: &str) -> Message

pub fn builder<'a>() -> MessageBuilder<'a>

Creates a message builder as alternative to building an irc string before creating the message.

pub fn to_builder(&self) -> MessageBuilder

Creates a builder from this message. Only initializes fields already present in the message. By using this method a whole new Message will be created.

pub fn tags(&self) -> Option<Tags>

Returns tags if any are present.

pub fn prefix(&self) -> Option<Prefix>

Returns the Prefix if present.

pub fn command(&self) -> &str

Returns the command the message represents.

pub fn params(&self) -> Option<Params>

Returns the params if any are present.

Trait Implementations

impl Display for Message

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

Formats the value using the given formatter.