Struct twitch_api2::TmiClient

pub struct TmiClient<'a, C: HttpClient<'a>> { /* fields omitted */ }

This is supported on crate features client and tmi only.

Client for the twitch TMI endpoint, almost entirely undocumented and certainly not supported.

Examples

let client = TmiClient::new();
println!("{:?}", client.get_chatters("justinfan10").await?);

Most clients will be able to use the 'static lifetime

pub struct MyStruct {
    twitch: TmiClient<'static, surf::Client>,
    token: twitch_oauth2::AppAccessToken,
}
// etc

See HttpClient for implemented http clients, you can also define your own if needed.

Implementations

impl<'a, C: HttpClient<'a>> TmiClient<'a, C>

pub fn new() -> TmiClient<'a, C> where
    C: Default, 

Create a new client with a default

pub fn with_client(client: C) -> TmiClient<'a, C>

Create a new TmiClient with an existing HttpClient

pub fn clone_client(&self) -> C where
    C: Clone, 

Retrieve a clone of the HttpClient inside this TmiClient

pub async fn get_chatters(
    &'a self,
    broadcaster: &str
) -> Result<GetChatters, RequestError<<C as HttpClient<'a>>::Error>>

Get all the chatters in the chat

Notes

This function will aside from url sanitize the broadcasters username, will also remove any # and make it lowercase ascii

pub async fn get_hosts(
    &'a self,
    include_logins: bool,
    channel_id: HostsRequestId
) -> Result<GetHosts, RequestError<<C as HttpClient<'a>>::Error>>

Get the broadcaster that a given channel is hosting, or the list of channels hosting a given target broadcaster.

Notes

This endpoint requires host={id} XOR target={id} in the query (providing both will result in an error, therefore this function takes a HostsRequestId enum).

Trait Implementations

impl<'a, C: Clone + HttpClient<'a>> Clone for TmiClient<'a, C>

fn clone(&self) -> TmiClient<'a, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, C: Default + HttpClient<'a>> Default for TmiClient<'a, C>

fn default() -> TmiClient<'a, C>

Returns the "default value" for a type.