Struct twitch_api2::helix::chat::ChannelEmote

#[non_exhaustive]
pub struct ChannelEmote {
    pub id: EmoteId,
    pub name: String,
    pub images: Image,
    pub tier: Option<SubscriptionTier>,
    pub emote_type: String,
    pub emote_set_id: EmoteSetId,
    pub format: Vec<EmoteAnimationSetting>,
    pub scale: Vec<EmoteScale>,
    pub theme_mode: Vec<EmoteThemeMode>,
}

Available on crate feature helix only.

A chat emote

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: EmoteId

ID of the emote.

name: String

Name of the emote a viewer types into Twitch chat for the image to appear.

images: Image

Object of image URLs for the emote.

tier: Option<SubscriptionTier>

If the emote_type is “subscriptions”, this indicates the subscriber tier at which the emote is unlocked. Set to an empty string otherwise.

emote_type: String

The type of emote.

The most common values for custom channel emotes are

subscriptions: Indicates a custom subscriber emote.

bitstier: Indicates a custom Bits tier emote.

follower: Indicates a custom follower emote.

emote_set_id: EmoteSetId

ID of the emote set the emote belongs to.

format: Vec<EmoteAnimationSetting>

The formats that the emote is available in.

scale: Vec<EmoteScale>

The sizes that the emote is available in.

theme_mode: Vec<EmoteThemeMode>

The background themes that the emote is available in.

Implementations

impl ChannelEmote

pub fn url(&self) -> EmoteUrlBuilder<'_>

Create an emote builder for this emote.

Examples

let emotes = client.get_channel_emotes_from_login("twitchdev", &token).await?.expect("user not found");
assert_eq!(emotes[0].url().size_3x().dark_mode().render(), "https://static-cdn.jtvnw.net/emoticons/v2/emotesv2_dc24652ada1e4c84a5e3ceebae4de709/default/dark/3.0");

Trait Implementations

impl Clone for ChannelEmote

fn clone(&self) -> ChannelEmote

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelEmote

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelEmote

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<ChannelEmote> for ChannelEmote

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

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

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

This method tests for !=.

impl Serialize for ChannelEmote

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChannelEmote