Struct irc3::proto::message::Message

pub struct Message { /* fields omitted */ }

A full IRC message that can be reprocessed back into its encoded form.

An IRC message can be parsed from a raw message, or it can built using the [new] constructor and the builder functions [with_tag], [with_tag_vendor], [with_prefix] and [with_param].

Examples

use irc3::Message;

fn main() {
	const MSG: &'static str = ":dan!d@localhost PRIVMSG * :Hey guys, what's up?";

	let built_message = Message::new("PRIVMSG")
		.with_prefix("dan", Some("d"), Some("localhost"))
		.with_param("*")
		.with_param("Hey guys, what's up?");
 	
	let parsed_message = Message::parse(MSG).unwrap();

	assert!(built_message == parsed_message);
}

Methods

impl Message

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

pub fn parse<S: AsRef<str> + ?Sized>(s: &S) -> Result<Message>

pub fn command(&self) -> &str

pub fn has_prefix(&self) -> bool

pub fn origin(&self) -> Option<&str>

pub fn user(&self) -> Option<&str>

pub fn host(&self) -> Option<&str>

pub fn params(&self) -> Iter<String>

pub fn param(&self, ind: usize) -> Option<&str>

pub fn tags(&self) -> Iter<Tag>

pub fn tag(&self, key: &str) -> Option<&Tag>

pub fn with_prefix(
    self,
    origin: &str,
    user: Option<&str>,
    host: Option<&str>
) -> Message

pub fn with_tag(self, key: &str, value: Option<&str>) -> Message

pub fn with_tag_vendor(
    self,
    key: &str,
    value: Option<&str>,
    vendor: Option<&str>
) -> Message

pub fn with_param(self, param: &str) -> Message

Trait Implementations

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<(), FmtError>

Formats the value using the given formatter.

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 Sink<Message> for Client

type Error = MessageTransportError

The type of value produced by the sink when an error occurs.

fn poll_ready(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, msg: Message) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<R> Sink<Message> for MessageTransport<R> where
    R: AsyncRead + AsyncWrite + Unpin, 

type Error = MessageTransportError

The type of value produced by the sink when an error occurs.

fn poll_ready(
    self: Pin<&mut Self>,
    _: &mut Context
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Message) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl StructuralPartialEq for Message