Struct twitch_api2::helix::streams::get_streams::GetStreamsRequest

#[non_exhaustive]pub struct GetStreamsRequest {
    pub after: Option<Cursor>,
    pub before: Option<Cursor>,
    pub first: Option<usize>,
    pub game_id: Vec<CategoryId>,
    pub language: Option<String>,
    pub user_id: Vec<UserId>,
    pub user_login: Vec<UserName>,
}

This is supported on crate feature helix only.

Query Parameters for Get Streams

get-streams

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.

after: Option<Cursor>

Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.

before: Option<Cursor>

Cursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.

first: Option<usize>

Maximum number of objects to return. Maximum: 100. Default: 20.

game_id: Vec<CategoryId>

Returns streams broadcasting a specified game ID. You can specify up to 10 IDs.

language: Option<String>

Stream language. You can specify up to 100 languages.

user_id: Vec<UserId>

Returns streams broadcast by one or more specified user IDs. You can specify up to 100 IDs.

user_login: Vec<UserName>

Returns streams broadcast by one or more specified user login names. You can specify up to 100 names.

Implementations

impl GetStreamsRequest

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

Create a builder for building GetStreamsRequest. On the builder, call .after(...)(optional), .before(...)(optional), .first(...)(optional), .game_id(...)(optional), .language(...)(optional), .user_id(...)(optional), .user_login(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of GetStreamsRequest.

Trait Implementations

impl Clone for GetStreamsRequest

fn clone(&self) -> GetStreamsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetStreamsRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GetStreamsRequest

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

Deserialize this value from the given Serde deserializer.

impl Paginated for GetStreamsRequest

fn set_pagination(&mut self, cursor: Option<Cursor>)

Should returns the current pagination cursor.

impl PartialEq<GetStreamsRequest> for GetStreamsRequest

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

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

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

This method tests for !=.

impl Request for GetStreamsRequest

type Response = Vec<Stream>

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

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

const OPT_SCOPE: &'static [Scope]

Optional 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 GetStreamsRequest

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 GetStreamsRequest

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 GetStreamsRequest