Struct twitch_api2::helix::streams::GetStreamsRequest [−][src]
#[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>, }
helix
only.Query Parameters for Get Streams
Fields (Non-exhaustive)
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
[src]
impl GetStreamsRequest
[src]pub fn builder() -> GetStreamsRequestBuilder<((), (), (), (), (), (), ())>
[src]
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
[src]
impl Clone for GetStreamsRequest
[src]fn clone(&self) -> GetStreamsRequest
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'de> Deserialize<'de> for GetStreamsRequest
[src]
impl<'de> Deserialize<'de> for GetStreamsRequest
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Paginated for GetStreamsRequest
[src]
impl Paginated for GetStreamsRequest
[src]fn set_pagination(&mut self, cursor: Option<Cursor>)
[src]
impl PartialEq<GetStreamsRequest> for GetStreamsRequest
[src]
impl PartialEq<GetStreamsRequest> for GetStreamsRequest
[src]fn eq(&self, other: &GetStreamsRequest) -> bool
[src]
fn ne(&self, other: &GetStreamsRequest) -> bool
[src]
impl Request for GetStreamsRequest
[src]
impl Request for GetStreamsRequest
[src]type Response = Vec<Stream>
Response type. twitch’s response will deserialize to this.
const PATH: &'static str
[src]
const SCOPE: &'static [Scope]
[src]
const OPT_SCOPE: &'static [Scope]
[src]
fn query(&self) -> Result<String, Error>
[src]
fn get_uri(&self) -> Result<Uri, InvalidUri>
[src]
fn get_bare_uri() -> Result<Uri, InvalidUri>
[src]
impl RequestGet for GetStreamsRequest
[src]
impl RequestGet for GetStreamsRequest
[src]fn create_request(
&self,
token: &str,
client_id: &str
) -> Result<Request<Vec<u8>>, CreateRequestError>
[src]
&self,
token: &str,
client_id: &str
) -> Result<Request<Vec<u8>>, CreateRequestError>
fn parse_response(
request: Option<Self>,
uri: &Uri,
response: Response<Vec<u8>>
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
[src]
request: Option<Self>,
uri: &Uri,
response: Response<Vec<u8>>
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
fn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
_status: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
[src]
request: Option<Self>,
uri: &Uri,
response: &str,
_status: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
impl Serialize for GetStreamsRequest
[src]
impl Serialize for GetStreamsRequest
[src]Auto Trait Implementations
impl RefUnwindSafe for GetStreamsRequest
impl RefUnwindSafe for GetStreamsRequest
impl Send for GetStreamsRequest
impl Send for GetStreamsRequest
impl Sync for GetStreamsRequest
impl Sync for GetStreamsRequest
impl Unpin for GetStreamsRequest
impl Unpin for GetStreamsRequest
impl UnwindSafe for GetStreamsRequest
impl UnwindSafe for GetStreamsRequest
Blanket Implementations
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
impl<T> WithSubscriber for T
[src]pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,