#[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.
Expand description

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)§

This struct is marked as 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§

source§

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

source

pub fn new() -> TwitchClient<'static, C>where C: Clone + ClientDefault<'static>,

Create a new TwitchClient

source§

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

source

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

Create a new TwitchClient with an existing HttpClient

source

pub fn get_client(&self) -> &C

Retrieve a reference of the HttpClient inside this TwitchClient

Trait Implementations§

source§

impl<'c, C: Client + Sync> Client for TwitchClient<'c, C>

Available on crate features tmi or helix only.
§

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

Error returned by the client
source§

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

Send a request
source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a, C> RefUnwindSafe for TwitchClient<'a, C>where C: RefUnwindSafe,

§

impl<'a, C> Send for TwitchClient<'a, C>

§

impl<'a, C> Sync for TwitchClient<'a, C>

§

impl<'a, C> Unpin for TwitchClient<'a, C>where C: Unpin,

§

impl<'a, C> UnwindSafe for TwitchClient<'a, C>where C: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more