Struct irc_rust::Message

pub struct Message { /* fields omitted */ }

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

All types returned from getters of this type ([Prefix, Params, Tags]) are owned types. So they are tied to the Message instance they are retrieved from and don’t own their part of the message.

Parses its part lazily on method invokations.

Examples

Create a Message from a plain string.

use irc_rust::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;
use std::error::Error;

fn main() -> Result<(), Box<dyn Error>> {
    let message = Message::builder("CMD")
        .tag("key1", "value1")
        .tag("key2", "value2")
        .prefix("name", Some("user"), Some("host"))
        .param("param1").param("param2")
        .trailing("trailing")
        .build();

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

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;
use std::error::Error;

fn main() -> Result<(), Box<dyn Error>> {
    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!");
    Ok(())
}

Implementations

impl Message

pub fn builder(command: &str) -> MessageBuilder<'_>

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

pub fn to_builder(&self) -> Result<MessageBuilder<'_>, InvalidIrcFormatError>

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) -> Result<Option<Tags<'_>>, InvalidIrcFormatError>

Returns tags if any are present.

pub fn prefix(&self) -> Result<Option<Prefix<'_>>, InvalidIrcFormatError>

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

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

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<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Message

impl From<&'_ str> for Message

fn from(raw: &str) -> Self

Performs the conversion.

impl From<String> for Message

fn from(raw: String) -> Self

Performs the conversion.

impl Hash for Message

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Message

fn cmp(&self, other: &Message) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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

fn partial_cmp(&self, other: &Message) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Message

impl StructuralPartialEq for Message