#[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>, }
Available on crate feature helix only.
Expand description

Query Parameters for Get Streams

get-streams

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.
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

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Deserialize this value from the given Serde deserializer. Read more

Should returns the current pagination cursor. Read more

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

This method tests for !=.

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

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

Available on crate feature twitch_oauth2 only.

Scopes needed by this endpoint

Available on crate feature twitch_oauth2 only.

Optional scopes needed by this endpoint

Defines layout of the url parameters.

Returns full URI for the request, including query parameters.

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

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

Parse response. Read more

Parse a response string into the response.

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

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

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

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

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

Calls U::from(self).

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

Should always be Self

The resulting type after obtaining ownership.

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

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

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

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

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