Struct twitch_api2::helix::users::get_users::GetUsersRequest

#[non_exhaustive]pub struct GetUsersRequest {
    pub id: Vec<UserId>,
    pub login: Vec<UserName>,
}

This is supported on crate feature helix only.

Query Parameters for Get Users

get-users

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.

id: Vec<UserId>

User ID. Multiple user IDs can be specified. Limit: 100.

login: Vec<UserName>

User login name. Multiple login names can be specified. Limit: 100.

Implementations

impl GetUsersRequest

pub fn builder() -> GetUsersRequestBuilder<((), ())>

Create a builder for building GetUsersRequest. On the builder, call .id(...)(optional), .login(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of GetUsersRequest.

Trait Implementations

impl Clone for GetUsersRequest

fn clone(&self) -> GetUsersRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetUsersRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GetUsersRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<GetUsersRequest> for GetUsersRequest

fn eq(&self, other: &GetUsersRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GetUsersRequest) -> bool

This method tests for !=.

impl Request for GetUsersRequest

type Response = Vec<User>

Response type. twitch's response will deserialize to this.

const OPT_SCOPE: &'static [Scope]

Optional scopes needed by this endpoint

const PATH: &'static str

The path to the endpoint relative to the helix root. eg. channels for Get Channel Information

const SCOPE: &'static [Scope]

Scopes needed by this endpoint

fn query(&self) -> Result<String, Error>

Defines layout of the url parameters.

fn get_uri(&self) -> Result<Uri, InvalidUri>

Returns full URI for the request, including query parameters.

fn get_bare_uri() -> Result<Uri, InvalidUri>

Returns bare URI for the request, NOT including query parameters.

impl RequestGet for GetUsersRequest

fn create_request(
    &self,
    token: &str,
    client_id: &str
) -> Result<Request<Vec<u8>>, CreateRequestError>

Create a http::Request from this Request in your client

fn parse_response(
    request: Option<Self>,
    uri: &Uri,
    response: Response<Vec<u8>>
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
    Self: Sized, 

Parse response. Override for different behavior

impl Serialize for GetUsersRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GetUsersRequest