Skip to main content

IrcMessage

Struct IrcMessage 

Source
pub struct IrcMessage {
    pub tags: HashMap<String, Option<String>>,
    pub prefix: Option<String>,
    pub command: String,
    pub params: Vec<String>,
}
Expand description

An IRC message with optional tags, prefix, command, and parameters

Fieldsยง

ยงtags: HashMap<String, Option<String>>

Message tags (IRCv3)

ยงprefix: Option<String>

Message prefix (source)

ยงcommand: String

IRC command

ยงparams: Vec<String>

Command parameters

Implementationsยง

Sourceยง

impl IrcMessage

Source

pub fn new(command: impl Into<String>) -> Self

Create a new IRC message with the given command

Source

pub fn with_params(self, params: Vec<String>) -> Self

Add parameters to the message

Source

pub fn with_prefix(self, prefix: impl Into<String>) -> Self

Add a prefix to the message

Source

pub fn with_tag(self, key: impl Into<String>, value: Option<String>) -> Self

Add a tag to the message

Source

pub fn with_tags(self, tags: HashMap<String, Option<String>>) -> Self

Add multiple tags to the message

Source

pub fn raw(data: &str) -> Self

Create a raw message (for debugging/testing)

Source

pub fn get_timestamp(&self) -> SystemTime

Extract server timestamp from message tags, fallback to current time

Source

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

Get the message ID from tags (if present)

Source

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

Get the account tag (if present)

Source

pub fn has_tag(&self, key: &str) -> bool

Check if this message has a specific tag

Source

pub fn get_tag(&self, key: &str) -> Option<&Option<String>>

Get a tag value

Source

pub fn is_message(&self) -> bool

Check if this is a PRIVMSG or NOTICE

Source

pub fn is_channel_message(&self) -> bool

Check if this is a channel message (target starts with # or &)

Source

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

Get the target of a message (first parameter)

Source

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

Get the message text (last parameter, typically)

Trait Implementationsยง

Sourceยง

impl Clone for IrcMessage

Sourceยง

fn clone(&self) -> IrcMessage

Returns a duplicate of the value. Read more
1.0.0 ยท Sourceยง

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

Performs copy-assignment from source. Read more
Sourceยง

impl Debug for IrcMessage

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl<'de> Deserialize<'de> for IrcMessage

Sourceยง

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Sourceยง

impl Display for IrcMessage

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl From<Reply> for IrcMessage

Sourceยง

fn from(reply: Reply) -> Self

Converts to this type from the input type.
Sourceยง

impl FromStr for IrcMessage

Sourceยง

type Err = IronError

The associated error which can be returned from parsing.
Sourceยง

fn from_str(line: &str) -> Result<Self>

Parses a string s to return a value of this type. Read more
Sourceยง

impl PartialEq for IrcMessage

Sourceยง

fn eq(&self, other: &IrcMessage) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 ยท Sourceยง

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

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

impl Serialize for IrcMessage

Sourceยง

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Sourceยง

impl StructuralPartialEq for IrcMessage

Auto Trait Implementationsยง

Blanket Implementationsยง

Sourceยง

impl<T> Any for T
where T: 'static + ?Sized,

Sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Sourceยง

impl<T> Borrow<T> for T
where T: ?Sized,

Sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Sourceยง

impl<T> BorrowMut<T> for T
where T: ?Sized,

Sourceยง

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Sourceยง

impl<T> CloneToUninit for T
where T: Clone,

Sourceยง

unsafe fn clone_to_uninit(&self, dest: *mut u8)

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

Sourceยง

impl<T, U> Into<U> for T
where U: From<T>,

Sourceยง

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Sourceยง

impl<T> Same for T

Sourceยง

type Output = T

Should always be Self
Sourceยง

impl<T> ToOwned for T
where T: Clone,

Sourceยง

type Owned = T

The resulting type after obtaining ownership.
Sourceยง

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Sourceยง

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Sourceยง

impl<T> ToString for T
where T: Display + ?Sized,

Sourceยง

fn to_string(&self) -> String

Converts the given value to a String. Read more
Sourceยง

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Sourceยง

type Error = Infallible

The type returned in the event of a conversion error.
Sourceยง

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Sourceยง

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Sourceยง

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Sourceยง

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Sourceยง

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Sourceยง

fn vzip(self) -> V

Sourceยง

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,