Struct twitch_irc::message::IRCTags

pub struct IRCTags(pub HashMap<String, Option<String>>);

A map of key-value IRCv3 tags.

Examples

use twitch_irc::message::IRCTags;
use twitch_irc::message::AsRawIRC;
use maplit::hashmap;

let tags = IRCTags::parse("key=value;key2=value2;key3");
assert_eq!(tags, hashmap! {
    "key".to_owned() => Some("value".to_owned()),
    "key2".to_owned() => Some("value2".to_owned()),
    "key3".to_owned() => None
})

Tuple Fields

0: HashMap<String, Option<String>>

Implementations

impl IRCTags

pub fn new() -> IRCTags

Creates a new empty map of tags.

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

Parses a new set of tags from their wire-format representation. source should be specified without the leading @ present in the full IRC tags.

Panics

Panics if source is an empty string.

Trait Implementations

impl AsRawIRC for IRCTags

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

Writes the raw IRC message to the given formatter.

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

Creates a new string with the raw IRC message.

impl Clone for IRCTags

fn clone(&self) -> IRCTags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IRCTags

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

Formats the value using the given formatter.

impl Default for IRCTags

fn default() -> IRCTags

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IRCTags

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

Deserialize this value from the given Serde deserializer.

impl From<HashMap<String, Option<String>, RandomState>> for IRCTags

fn from(map: HashMap<String, Option<String>, RandomState>) -> Self

Converts to this type from the input type.

impl PartialEq<HashMap<String, Option<String>, RandomState>> for IRCTags

fn eq(&self, other: &HashMap<String, Option<String>, RandomState>) -> bool

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

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

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

impl PartialEq<IRCTags> for HashMap<String, Option<String>>

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

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

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

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

impl PartialEq<IRCTags> for IRCTags

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

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

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

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

impl Serialize for IRCTags

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

Serialize this value into the given Serde serializer.

impl Eq for IRCTags

impl StructuralEq for IRCTags

impl StructuralPartialEq for IRCTags