Struct twitch_api_rs::resource::users::get_users::GetUsersRequest

pub struct GetUsersRequest<A> where
    A: AuthToken,  { /* fields omitted */ }

Request to the Get Users endpoint

See module level documentation for usage

Implementations

impl<A: AuthToken> GetUsersRequest<A>

pub fn set_auth(&mut self, auth: A) -> &mut Self

Set the authorization token to use

Consumes the token, so should be cloned if you plan to re-use TODO offer reference counted storage for fewer allocations.

pub fn add_id<S: Into<UserId>>(&mut self, id: S) -> &mut Self

Add the id to the set of ids to be sent. May not have more than 100 ids and logins

pub fn set_ids<C, S>(&mut self, ids: C) -> &mut Self where
    C: IntoIterator<Item = S>,
    S: Into<UserId>, 

Replace the set of ids to be sent

let mut req = GetUsersRequest::builder();
req.set_ids(vec!["477906794"]);
// ...

pub fn clear_ids(&mut self) -> &mut Self

Clear the set of ids to be sent

pub fn add_login<S: Into<UserName>>(&mut self, login: S) -> &mut Self

Add the login to the set of logins to be sent. May not have more than 100 ids and logins

pub fn clear_logins(&mut self) -> &mut Self

Clear the set of ids to be sent

pub fn set_logins<C, S>(&mut self, logins: C) -> &mut Self where
    C: IntoIterator<Item = S>,
    S: Into<UserName>, 

Replace the set of logins to be sent

let mut req = GetUsersRequest::builder();
req.set_ids(vec!["TheHoodlum12", "Denims"]);
// ...

Trait Implementations

impl<A: Debug> Debug for GetUsersRequest<A> where
    A: AuthToken, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<A> Request for GetUsersRequest<A> where
    A: AuthToken + Send, 

const ENDPOINT: &'static str

Endpoint where the request is made

const METHOD: Method

The method that this request will use

type Headers = A

The type that represents the headers sent with this request

type Parameters = Self

The type that represents the query parameters sent with this request

type Body = ()

The type that represents the body of this request

type Response = GetUsersResponse

The type returned by a sucessful request, must be DeserializeOwned and have at least a static lifetime (owned).

type ErrorCodes = CommonResponseCodes

The type that encapsulates the error codes that this endpoint can return, must have at least a static lifetime (owned).

fn builder() -> Self

Get a builder for this method

fn headers(&self) -> &Self::Headers

Get the Headers struct for this Request

fn parameters(&self) -> &Self::Parameters

Get the Parameters struct for this Request

fn body(&self) -> &Self::Body

Get the Body struct for this Request

fn ready(&self) -> Result<(), RequestError<Self::ErrorCodes>>

Must return Ok(()) if and only if this request is ready to have Self::make_request called on it.

#[must_use]fn make_request<'life0, 'async_trait, C>(
    &'life0 self,
    client: C
) -> Pin<Box<dyn Future<Output = Result<Self::Response, RequestError<Self::ErrorCodes>>> + Send + 'async_trait>> where
    C: Borrow<Client> + Send,
    C: 'async_trait,
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Make the request represented by this object. Only makes request if Self::ready returns Ok(()).