Crate twitch_api2

Expand description

Rust library for talking with the new Twitch API aka. "Helix", TMI and more! Use Twitch endpoints fearlessly!

Examples

Get information about a channel with the Get Channel Information helix endpoint.

use twitch_api2::{helix::channels::GetChannelInformationRequest, TwitchClient};
use twitch_oauth2::{tokens::errors::AppAccessTokenError, AppAccessToken, Scope, TwitchToken};


let client: TwitchClient<reqwest::Client> = TwitchClient::default();
let token =
    AppAccessToken::get_app_access_token(&client, client_id, client_secret, Scope::all())
        .await?;
let req = GetChannelInformationRequest::builder()
    .broadcaster_id("27620241")
    .build();
println!(
    "{:?}",
    &client.helix.req_get(req, &token).await?.data.unwrap().title
);

There is also a convenience function for accessing channel information with a specified login name

let client = TwitchClient::default();

println!("{:?}", &client.helix.get_channel_from_login("twitch".to_string(), &token).await?.unwrap().title);

Features

This crate provides almost no functionality by default, only exposing types. To enable more features, refer to below table.

Feature
`twitch_oauth2`	Gives scopes for endpoints and topics that are needed to call them.
`client`	Gives a client abstraction for endpoints. See for example `TmiClient` and `HelixClient`
`helix`	Enables Helix endpoints
`tmi`	Enables TMI endpoints
`eventsub`	Enables deserializable structs for EventSub
`pubsub`	Enables deserializable structs for PubSub
`hmac`	Enable message authentication using HMAC on EventSub
`time`	Enable time utilities on Timestamp
`all`	Enables all above features. Including reqwest and surf. Do not use this in production, it’s better if you specify exactly what you need
`ureq`	Enables ureq for `HttpClient`.
`surf`	Enables surf for `HttpClient`. Note that this does not enable any default client backend, if you get a compile error, specify `surf` in your `Cargo.toml`. By default, `surf` uses feature `curl-client`
`reqwest`	Enables reqwest for `HttpClient`. Note that this does not enable any default TLS backend, if you get `invalid URL, scheme is not http`, specify `reqwest` in your Cargo.toml. By default, `reqwest` uses feature `default-tls`
`unsupported`	Enables undocumented or experimental endpoints, topics or features. Breakage may occur, semver compatibility not guaranteed.
`trace_unknown_fields`	Logs ignored fields as `WARN` log messages where applicable. Please consider using this and filing an issue or PR when a new field has been added to the endpoint but not added to this library.
`deny_unknown_fields`	Adds `#[serde(deny_unknown_fields)]` on all applicable structs/enums. Please consider using this and filing an issue or PR when a new field has been added to the endpoint but not added to this library.