Struct irc_rust::message::Message

pub struct Message { /* fields omitted */ }

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

Examples

use irc_rust::message::Message;

let message = Message::new("@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");

use irc_rust::message::Message;
use irc_rust::prefix::Prefix;

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

match message {
    Ok(mssg) => {
        let tags = mssg.tags().unwrap();
        println!("key1={}", tags["key1"]) // Prints 'key1=value1'
    }
    Err(e) => println!("message building failed: {}", e)
}

Methods

impl Message

pub fn new(value: &str) -> Message

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

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

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

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 ToString for Message

fn to_string(&self) -> String

Converts the given value to a String.