Struct twitch_api2::pubsub::channel_points::Reward
source · [−]#[non_exhaustive]pub struct Reward {Show 21 fields
pub background_color: String,
pub channel_id: UserId,
pub cooldown_expires_at: Option<Timestamp>,
pub cost: u32,
pub default_image: Option<Image>,
pub global_cooldown: GlobalCooldown,
pub id: RewardId,
pub image: Option<Image>,
pub is_enabled: bool,
pub is_in_stock: bool,
pub is_paused: bool,
pub is_sub_only: bool,
pub is_user_input_required: bool,
pub max_per_stream: Max,
pub max_per_user_per_stream: Max,
pub prompt: String,
pub redemptions_redeemed_current_stream: Option<u32>,
pub should_redemptions_skip_request_queue: bool,
pub template_id: Option<String>,
pub title: String,
pub updated_for_indicator_at: Option<Timestamp>,
}
pubsub
only.Expand description
Reward data
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.background_color: String
Color of background in rewards & challenges screen on client
channel_id: UserId
ID of channel where the redemption was triggered
cooldown_expires_at: Option<Timestamp>
Cooldown will expire after this timestamp
cost: u32
Cost of reward.
default_image: Option<Image>
Default image of reward in rewards & challenges screen on client
global_cooldown: GlobalCooldown
Information about global cooldown
id: RewardId
ID of reward.
image: Option<Image>
Set image of reward in rewards & challenges screen on client. If none, see Reward::default_image
is_enabled: bool
Reward is enabled or not.
is_in_stock: bool
Reward is in stock
is_paused: bool
Reward is paused
is_sub_only: bool
Reward is sub only
is_user_input_required: bool
Reward requires input from user on rewards & challenges screen on client
max_per_stream: Max
Maximum redemptions per stream
max_per_user_per_stream: Max
Maximum redemptions per user per stream
prompt: String
Prompt shown when clicking reward on rewards & challenges screen on client
redemptions_redeemed_current_stream: Option<u32>
Amount of times this has been redeemed this stream.
should_redemptions_skip_request_queue: bool
Does redemption skip queue?
template_id: Option<String>
Template ID
title: String
Title or Name of reward
updated_for_indicator_at: Option<Timestamp>
Unknown
Trait Implementations
sourceimpl<'de> Deserialize<'de> for Reward
impl<'de> Deserialize<'de> for Reward
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
impl Eq for Reward
impl StructuralEq for Reward
impl StructuralPartialEq for Reward
Auto Trait Implementations
impl RefUnwindSafe for Reward
impl Send for Reward
impl Sync for Reward
impl Unpin for Reward
impl UnwindSafe for Reward
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
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 Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
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.
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more