Enum twitch_irc::message::IRCPrefix

pub enum IRCPrefix {
    HostOnly {
        host: String,
    },
    Full {
        nick: String,
        user: Option<String>,
        host: Option<String>,
    },
}

A "prefix" part of an IRC message, as defined by RFC 2812:

<prefix>     ::= <servername> | <nick> [ '!' <user> ] [ '@' <host> ]
<servername> ::= <host>
<nick>       ::= <letter> { <letter> | <number> | <special> }
<user>       ::= <nonwhite> { <nonwhite> }
<host>       ::= see RFC 952 [DNS:4] for details on allowed hostnames
<letter>     ::= 'a' ... 'z' | 'A' ... 'Z'
<number>     ::= '0' ... '9'
<special>    ::= '-' | '[' | ']' | '\' | '`' | '^' | '{' | '}'
<nonwhite>   ::= <any 8bit code except SPACE (0x20), NUL (0x0), CR
                  (0xd), and LF (0xa)>

Examples

use twitch_irc::message::IRCPrefix;
use twitch_irc::message::AsRawIRC;

let prefix = IRCPrefix::Full {
    nick: "a_nick".to_owned(),
    user: Some("a_user".to_owned()),
    host: Some("a_host.com".to_owned())
};

assert_eq!(prefix.as_raw_irc(), "a_nick!a_user@a_host.com");

use twitch_irc::message::IRCPrefix;
use twitch_irc::message::AsRawIRC;

let prefix = IRCPrefix::Full {
    nick: "a_nick".to_owned(),
    user: None,
    host: Some("a_host.com".to_owned())
};

assert_eq!(prefix.as_raw_irc(), "a_nick@a_host.com");

use twitch_irc::message::IRCPrefix;
use twitch_irc::message::AsRawIRC;

let prefix = IRCPrefix::HostOnly {
    host: "a_host.com".to_owned()
};

assert_eq!(prefix.as_raw_irc(), "a_host.com");

Variants

HostOnly

The prefix specifies only a sending server/hostname.

Note that the spec also allows a very similar format where only a sending nickname is specified. However that type of format plays no role on Twitch, and is practically impossible to reliably tell apart from host-only prefix messages. For this reason, a prefix without a @ character is always assumed to be purely a host-only prefix, and not a nickname-only prefix.

Fields of HostOnly

host: String

host part of the prefix

Full

The prefix variant specifies a nickname, and optionally also a username and optionally a hostname. See above for the RFC definition.

Fields of Full

nick: String

nick part of the prefix

user: Option<String>

user part of the prefix

host: Option<String>

host part of the prefix

Implementations

impl IRCPrefix

pub fn parse(source: &str) -> IRCPrefix

Parse the IRCPrefix from the given string slice. source should be specified without the leading : that precedes in full IRC messages.

Examples

use twitch_irc::message::IRCPrefix;

let prefix = IRCPrefix::parse("a_nick!a_user@a_host.com");
assert_eq!(prefix, IRCPrefix::Full {
    nick: "a_nick".to_owned(),
    user: Some("a_user".to_owned()),
    host: Some("a_host.com".to_owned())
})

use twitch_irc::message::IRCPrefix;

let prefix = IRCPrefix::parse("a_host.com");
assert_eq!(prefix, IRCPrefix::HostOnly {
    host: "a_host.com".to_owned()
})

Trait Implementations

impl AsRawIRC for IRCPrefix

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

Writes the raw IRC message to the given formatter.

fn as_raw_irc(&self) -> String where
    Self: Sized, 

Creates a new string with the raw IRC message.

impl Clone for IRCPrefix

fn clone(&self) -> IRCPrefix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IRCPrefix

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

Formats the value using the given formatter.

impl Hash for IRCPrefix

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl PartialEq<IRCPrefix> for IRCPrefix

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for IRCPrefix