Struct TwitchClient

#[non_exhaustive]
pub struct TwitchClient<'a, C>
where
    C: HttpClient<'a>,
{
    pub helix: HelixClient<'a, C>,
    pub tmi: TmiClient<'a, C>,
}

Available on crate feature client and (crate features helix or tmi) only.

Client for Twitch APIs.

Most http clients will be able to use the 'static lifetime

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

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

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.

helix: HelixClient<'a, C>

Available on crate feature helix only.

Helix endpoint. See helix

tmi: TmiClient<'a, C>

Available on crate feature tmi only.

TMI endpoint. See tmi

Implementations

impl<C: HttpClient<'static>> TwitchClient<'static, C>

pub fn new() -> TwitchClient<'static, C>

where C: Clone + ClientDefault<'static>,

Create a new TwitchClient

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

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

where C: Clone,

Create a new TwitchClient with an existing HttpClient

pub fn get_client(&self) -> &C

Retrieve a reference of the HttpClient inside this TwitchClient

Trait Implementations

impl<'a, C: Client<'a> + Sync> Client<'a> for TwitchClient<'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 for TwitchClient<'a, C>

where C: HttpClient<'a> + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

fn default() -> Self

Returns the “default value” for a type.