Struct simple_irc::Message

pub struct Message {
    pub tags: BTreeMap<String, String>,
    pub prefix: Option<Prefix>,
    pub command: String,
    pub params: Vec<String>,
}

A structural representation of an IRC message.

Note that this library does not guarantee that messages will be preserved byte-for-byte, but all messages will have the same semantic meaning.

// use std::convert::FromStr;
let msg = "HELLO world".parse::<simple_irc::Message>().unwrap();
assert_eq!(msg.tags.len(), 0);
assert_eq!(msg.prefix, None);
assert_eq!(&msg.command[..], "HELLO");
assert_eq!(msg.params.len(), 1);
assert_eq!(&msg.params[0][..], "world");

assert_eq!(&msg.to_string(), "HELLO :world");

Fields

tags: BTreeMap<String, String>

prefix: Option<Prefix>

command: String

params: Vec<String>

Methods

impl Message

pub fn new(command: String, params: Vec<String>) -> Self

pub fn new_with_all(
    tags: BTreeMap<String, String>,
    prefix: Option<Prefix>,
    command: String,
    params: Vec<String>
) -> Self

pub fn new_with_prefix(
    command: String,
    params: Vec<String>,
    prefix: Prefix
) -> Self

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

Formats the value using the given formatter.

impl Default for Message

fn default() -> Message

Returns the "default value" for a type.

impl Display for Message

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

Formats the value using the given formatter.

impl FromStr for Message

type Err = Error

The associated error which can be returned from parsing.

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

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

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