Struct twitchchat::UserConfig

pub struct UserConfig {
    pub name: String,
    pub token: String,
    pub capabilities: Vec<Capability>,
}

User configuration for 'registering' with Twitch

This is used to register the connection with the server

It contains your user name, your OAuth token and the capabilities you want to request.

example using a builder

// as anonymous
let config = UserConfig::builder().anonymous().build().unwrap();
// or with a name/token
let name = std::env::var("TWITCH_NAME").unwrap();
let token = std::env::var("TWITCH_TOKEN").unwrap();
let config = UserConfig::builder()
    .name(name)
    .token(token)
    .capabilities(&[Capability::Tags])
    .build()
    .unwrap();

Fields

name: String

Requested name of your user

token: String

OAuth token of the user

capabilities: Vec<Capability>

Capabilities to be requested from the server

Implementations

impl UserConfig

pub fn builder() -> UserConfigBuilder

Create a builder to make a Config

pub fn is_anonymous(&self) -> bool

Determines whether this config was requested as anonymous

Trait Implementations

impl Clone for UserConfig

fn clone(&self) -> UserConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserConfig

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

Deserialize this value from the given Serde deserializer.

impl IntoOwned<'static> for UserConfig

type Output = Self

The output type

fn into_owned(self) -> Self::Output

Consumes self, returning an owned version

impl PartialEq<UserConfig> for UserConfig

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

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

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

This method tests for !=.

impl Serialize for UserConfig

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 UserConfig