Struct twitch_api2::HelixClient

pub struct HelixClient { /* fields omitted */ }

Client for Helix or the New Twitch API

Implementations

impl HelixClient

pub fn new<T>(token: Box<T>) -> HelixClient where
    T: TwitchToken + Sized + Send + Sync + 'static, 

Create a new client with a default reqwest::Client

pub fn clone_client(&self) -> Client

Retrieve a clone of the reqwest::Client inside this HelixClient

pub async fn monitor_expire<'_>(&'_ self) -> Option<Delay>

Get a tokio::time::Delay that will return when the token attached to this client expires

pub async fn token<'_, '_>(
    &'_ self
) -> RwLockReadGuard<'_, Box<dyn TwitchToken + Send + Sync>>

Access the underlying TwitchToken from this client

pub async fn refresh_token<'_>(&'_ self) -> Result<(), RefreshTokenError>

Refresh the underlying TwitchToken

pub async fn get_channel_information<'_>(
    &'_ self,
    broadcaster_id: String
) -> Result<Option<GetChannel>, RequestError>

Get information about users channel with specific id

pub async fn get_streams<F, '_>(
    &'_ self,
    builder: F
) -> Result<Response<GetStreamsRequest, GetStreams>, RequestError> where
    F: FnOnce(GetStreamsRequestBuilder<((), (), (), (), (), (), ())>) -> GetStreamsRequest, 

Access GetStreams builder.

pub async fn get_users<F, '_>(
    &'_ self,
    builder: F
) -> Result<Response<GetUsersRequest, GetUsers>, RequestError> where
    F: FnOnce(GetUsersRequestBuilder<((), ())>) -> GetUsersRequest, 

Get user information. See users::get_users

pub async fn get_clips<F, '_>(
    &'_ self,
    builder: F
) -> Result<Response<GetClipsRequest, GetClips>, RequestError> where
    F: FnOnce(GetClipsRequestBuilder<((), (), (), (), (), (), (), ())>) -> GetClipsRequest, 

Get clip information. See clips::get_clips

pub async fn req_get<R, D, '_>(
    &'_ self,
    request: R
) -> Result<Response<R, D>, RequestError> where
    R: Request<Response = D> + Request,
    D: DeserializeOwned, 

Request on a valid Request endpoint

Trait Implementations

impl Clone for HelixClient

fn clone(&self) -> HelixClient

Returns a copy of the value.

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

Performs copy-assignment from source.