Struct twitch_api2::tmi::TmiClient

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

Available 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".into()).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 with_client(client: C) -> TmiClient<'a, C>

Create a new client with an existing client

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

Create a new TmiClient with a default HttpClient

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

Retrieve a clone of the HttpClient inside this TmiClient

pub fn get_client(&self) -> &C

Retrieve a reference of the HttpClient inside this TmiClient

pub async fn get_chatters(
    &'a self,
    broadcaster: &UserNameRef
) -> 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

Trait Implementations

impl<'a, C: Client<'a> + Sync> Client<'a> for TmiClient<'a, C>

type Error = CompatError<<C as Client<'a>>::Error>

Error returned by the client

fn req(
    &'a self,
    request: Request<Vec<u8>>
) -> BoxedFuture<'a, Result<Response<Vec<u8>>, <Self as Client<'_>>::Error>>

Send a request

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn default() -> Self

Returns the “default value” for a type.