Struct Emote

pub struct Emote<'a> {
    pub id: Cow<'a, str>,
    pub name: Cow<'a, str>,
    pub byte_pos: (usize, usize),
}

An emote attached to a message

Fields

id: Cow<'a, str>

The id of the emote (e.g. 25 for Kappa)

name: Cow<'a, str>

The name of the emote (e.g. Kappa)

byte_pos: (usize, usize)

The byte position of the emote (name) in the provided data

Implementations

impl<'a> Emote<'a>

pub fn from_tags<'t: 'a>( tags: &'t Tags<'a>, data: &'a str, ) -> impl Iterator<Item = Emote<'a>> + 't

Parse the emotes from tags and associated data

use twitch_message::{Tags, Emote};
use std::borrow::Cow;

let tags = Tags::builder().add("emotes", "25:0-4,14-18").finish();
let data = "Kappa testing Kappa";
let expected = [
    Emote { id: Cow::from("25"), name: Cow::from("Kappa"), byte_pos: (0, 5) },
    Emote { id: Cow::from("25"), name: Cow::from("Kappa"), byte_pos: (14, 19) },
];
for (i, emote) in Emote::from_tags(&tags, data).enumerate() {
    assert_eq!(expected[i], emote);
}

See also

Parsing from a string, such as from tags.get("emotes"), you can use parse_emotes

Trait Implementations

impl<'a> Clone for Emote<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Emote<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for Emote<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> Hash for Emote<'a>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Index<&Emote<'a>> for str

type Output = str

The returned type after indexing.

fn index(&self, index: &Emote<'a>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> Ord for Emote<'a>

fn cmp(&self, other: &Emote<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for Emote<'a>

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

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

const 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<'a> PartialOrd for Emote<'a>

fn partial_cmp(&self, other: &Emote<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Serialize for Emote<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for Emote<'a>

impl<'a> StructuralPartialEq for Emote<'a>