Struct tmi::client::Credentials

pub struct Credentials {
    pub login: String,
    pub token: Option<String>,
}

Credentials used to authenticate to Twitch IRC.

The Default impl uses Credentials::anon.

Fields

login: String

token: Option<String>

Implementations

impl Credentials

pub fn new(login: impl ToString, token: impl ToString) -> Self

Credentials using an OAuth token.

token should be a User Access Token.

You can generate one by following the instructions on Authorization Code Grant Flow.

Make sure the token is valid before attempting to use it, and refresh it or generate a new one if it expires.

twitch_oauth2 can help automate most of this.

pub fn anon() -> Self

An anonymous login.

Twitch allows logging in using any username in the form justinfan????? where ? is any digit. For example, justinfan11824 is a valid username.

If you login anonymously, you won’t be able to send messages, but you will still be able to read them, including all the usual tags, membership commands, etc.

pub fn is_anon(&self) -> bool

pub fn login(&self) -> &str

pub fn token(&self) -> Option<&str>

Trait Implementations

impl Clone for Credentials

fn clone(&self) -> Credentials

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Credentials

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

Formats the value using the given formatter.

impl Default for Credentials

fn default() -> Self

Returns the “default value” for a type.