Struct IrcMsg

pub struct IrcMsg<'msg> { /* private fields */ }

A single IRC Message created from a slice of bytes.

Implementations

impl<'msg> IrcMsg<'msg>

pub const fn parse(input: &'msg [u8]) -> Result<Self, IrcMsgError<'_>>

Generates an IrcMsg from a slice of bytes.

Errors

Will return Err if the input is empty or any of the IrcMsg components fail to parse.

pub const fn parse_utf8_only(input: &'msg [u8]) -> Result<Self, IrcMsgError<'_>>

Generates a utf8-only IrcMsg from a slice of bytes.

Errors

Will return Err if the input is empty, contains non-utf8 bytes or any of the IrcMsg components fail to parse.

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

Extract the Tags from an IrcMsg if they exist.

pub const fn source(&self) -> Option<Source<'_>>

Extract the Source from an IrcMsg if it exists.

pub const fn command(&self) -> Command<'_>

Extract the Command from an IrcMsg.

pub const fn parameters(&self) -> Option<Parameters<'_>>

Extract the Parameters from an IrcMsg if they exist.

pub const fn strip_tags(self) -> Self

Strips the Tags from an IrcMsg.

If a client doesn’t support IRC Tags you can strip them from the IrcMsg. Probably most useful for IRC server software as IRC servers should never send clients messages with Tags unless the client indicates their support for them.

Trait Implementations

impl<'msg> Clone for IrcMsg<'msg>

fn clone(&self) -> IrcMsg<'msg>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'msg> Debug for IrcMsg<'msg>

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

Formats the value using the given formatter.

impl<'msg> Display for IrcMsg<'msg>

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

Formats the value using the given formatter.

impl<'msg> PartialEq for IrcMsg<'msg>

fn eq(&self, other: &IrcMsg<'msg>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'msg> Copy for IrcMsg<'msg>

impl<'msg> Eq for IrcMsg<'msg>

impl<'msg> StructuralPartialEq for IrcMsg<'msg>