Struct Config

#[non_exhaustive]
pub struct Config {

    pub callout_emote_id: EmoteId,
    pub callout_emote_token: String,
    pub channel_id: Option<UserId>,
    pub conductor_rewards: ConductorRewards,
    pub cooldown_duration: i64,
    pub difficulty: HypeTrainDifficulty,
    pub difficulty_settings: HashMap<HypeTrainDifficulty, Vec<Level>>,
    pub is_enabled: bool,
    pub kickoff: Kickoff,
    pub level_duration: i64,
    pub notification_thresholds: NotificationThresholds,
    pub participation_conversion_rates: ParticipationConversionRates,
    pub theme_color: Option<String>,
    pub primary_hex_color: Option<String>,
    pub use_personalized_settings: Option<bool>,
    pub use_theme_color: Option<bool>,
    pub use_creator_color: Option<bool>,
    /* private fields */
}

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Available on crate features pubsub and unsupported only.

Configuration of hype train

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.

callout_emote_id: EmoteId

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Hype train public callout emote ID

callout_emote_token: String

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Hype train public callout emote token

channel_id: Option<UserId>

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

ID of channel

conductor_rewards: ConductorRewards

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Rewards for conductors

cooldown_duration: i64

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Cooldown duration in nanoseconds for hype train

difficulty: HypeTrainDifficulty

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Difficulty of hype train

difficulty_settings: HashMap<HypeTrainDifficulty, Vec<Level>>

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Difficulty settings

is_enabled: bool

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Whether or not Hype Train is enabled in channel

kickoff: Kickoff

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Support events that must occur within a duration of time to kick off a Hype Train.

level_duration: i64

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Duration in nanoseconds of each level

notification_thresholds: NotificationThresholds

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Thresholds for notifications

participation_conversion_rates: ParticipationConversionRates

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Conversion rates for participations

theme_color: Option<String>

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Theme color of channel

None if use_theme_color is set to false

primary_hex_color: Option<String>

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Primary color of hex

use_personalized_settings: Option<bool>

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Uses personalized settings

use_theme_color: Option<bool>

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Use theme color or not

use_creator_color: Option<bool>

👎Deprecated since 0.7.0: use EventSub instead, see https://discuss.dev.twitch.com/t/legacy-pubsub-deprecation-and-shutdown-timeline/58043

Use creator color or not

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

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

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

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 Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Config

impl StructuralPartialEq for Config