Struct twitch_api::helix::chat::ChannelEmote
source · [−]#[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.Expand description
A chat emote
Fields (Non-exhaustive)
This struct is marked as 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
sourceimpl ChannelEmote
impl ChannelEmote
sourcepub fn url(&self) -> EmoteUrlBuilder<'_>
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
sourceimpl Clone for ChannelEmote
impl Clone for ChannelEmote
sourcefn clone(&self) -> ChannelEmote
fn clone(&self) -> ChannelEmote
Returns a copy of the value. Read more
1.0.0 · sourceconst fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresourceimpl Debug for ChannelEmote
impl Debug for ChannelEmote
sourceimpl<'de> Deserialize<'de> for ChannelEmote
impl<'de> Deserialize<'de> for ChannelEmote
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<ChannelEmote> for ChannelEmote
impl PartialEq<ChannelEmote> for ChannelEmote
sourcefn eq(&self, other: &ChannelEmote) -> bool
fn eq(&self, other: &ChannelEmote) -> bool
sourceimpl Serialize for ChannelEmote
impl Serialize for ChannelEmote
impl Eq for ChannelEmote
impl StructuralEq for ChannelEmote
impl StructuralPartialEq for ChannelEmote
Auto Trait Implementations
impl RefUnwindSafe for ChannelEmote
impl Send for ChannelEmote
impl Sync for ChannelEmote
impl Unpin for ChannelEmote
impl UnwindSafe for ChannelEmote
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.