Struct ellidri_tokens::Tag

pub struct Tag<'a> {
    pub key: &'a str,
    pub value: Option<&'a str>,
}

A message tag.

Message tagging is an addition of an IRCv3 specification. Refer to the following page for more details on message tags: https://ircv3.net/specs/extensions/message-tags.

Fields

key: &'a str

The key of the tag.

value: Option<&'a str>

The value of the tag, or None when the tag has no value.

Methods

impl<'a> Tag<'a>

pub fn parse(buf: &'a str) -> Self

Parse a message tag.

Example

let tag = Tag::parse("label=123456");

assert_eq!(tag.key, "label");
assert_eq!(tag.value, Some("123456"));

pub fn is_client(&self) -> bool

Whether the tag is a client-only tag.

Example

let msgid = Tag::parse("msgid=42");
let reply = Tag::parse("+example.pizza/beer");

assert_eq!(msgid.is_client(), false);
assert_eq!(reply.is_client(), true);

pub fn unescape_value(&self) -> String

Returns the unescaped version of the tag's value.

Tag escaping is defined here: https://ircv3.net/specs/extensions/message-tags.html (look for "Escaping values").

Example

let label = Tag::parse(r"label=Newline:\s\nBackslash-n:\s\\n");

assert_eq!(&label.unescape_value(), "Newline: \nBackslash-n: \\n");

pub fn unescape_value_into(&self, buf: &mut String)

Appends the unescaped value of the tag to the given String.

If the string is already allocated and has enough space, then this function will not allocate. It is therefore preferable to use it if you already have a String. See Tag::unescape_value for doc about tag escaping.

Trait Implementations

impl<'a> Clone for Tag<'a>

fn clone(&self) -> Tag<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Tag<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Tag<'a>> for Tag<'a>

fn eq(&self, other: &Tag<'a>) -> bool

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

fn ne(&self, other: &Tag<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for Tag<'a>