Struct twitch_api::helix::streams::GetStreamsRequest
source · [−]#[non_exhaustive]pub struct GetStreamsRequest<'a> {
pub after: Option<Cow<'a, CursorRef>>,
pub before: Option<Cow<'a, CursorRef>>,
pub first: Option<usize>,
pub game_id: Cow<'a, [&'a CategoryIdRef]>,
pub language: Option<Cow<'a, str>>,
pub user_id: Cow<'a, [&'a UserIdRef]>,
pub user_login: Cow<'a, [&'a UserNameRef]>,
}
helix
only.Expand description
Query Parameters for Get Streams
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.after: Option<Cow<'a, CursorRef>>
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<Cow<'a, CursorRef>>
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: Cow<'a, [&'a CategoryIdRef]>
Returns streams broadcasting a specified game ID. You can specify up to 10 IDs.
language: Option<Cow<'a, str>>
Stream language. You can specify up to 100 languages.
user_id: Cow<'a, [&'a UserIdRef]>
Returns streams broadcast by one or more specified user IDs. You can specify up to 100 IDs.
user_login: Cow<'a, [&'a UserNameRef]>
Returns streams broadcast by one or more specified user login names. You can specify up to 100 names.
Implementations
sourceimpl<'a> GetStreamsRequest<'a>
impl<'a> GetStreamsRequest<'a>
sourcepub fn builder() -> GetStreamsRequestBuilder<'a, ((), (), (), (), (), (), ())>
pub fn builder() -> GetStreamsRequestBuilder<'a, ((), (), (), (), (), (), ())>
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
.
sourceimpl<'a> GetStreamsRequest<'a>
impl<'a> GetStreamsRequest<'a>
sourcepub fn user_ids(user_ids: impl Into<Cow<'a, [&'a UserIdRef]>>) -> Self
pub fn user_ids(user_ids: impl Into<Cow<'a, [&'a UserIdRef]>>) -> Self
Return streams for specified user ids
sourcepub fn user_logins(user_logins: impl Into<Cow<'a, [&'a UserNameRef]>>) -> Self
pub fn user_logins(user_logins: impl Into<Cow<'a, [&'a UserNameRef]>>) -> Self
Return streams for specified users by nickname
Examples found in repository?
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
async fn run() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
let _ = dotenvy::dotenv();
let mut args = std::env::args().skip(1);
let client: HelixClient<reqwest::Client> = HelixClient::new();
let token = UserToken::from_existing(
&client,
std::env::var("TWITCH_TOKEN")
.ok()
.or_else(|| args.next())
.map(AccessToken::new)
.expect("Please set env: TWITCH_TOKEN or pass token as first argument"),
None,
None,
)
.await
.unwrap();
let response = client
.req_get(
GetStreamsRequest::user_logins(
&[types::UserNameRef::from_str(&args.next().unwrap())][..],
),
&token,
)
.await
.unwrap()
.data;
println!("Stream information:\n\t{response:?}");
Ok(())
}
More examples
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
async fn run() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
let _ = dotenvy::dotenv();
let mut args = std::env::args().skip(1);
let foo_client = FooClient::default();
let token = UserToken::from_existing(
&foo_client.client,
std::env::var("TWITCH_TOKEN")
.ok()
.or_else(|| args.next())
.map(AccessToken::new)
.expect("Please set env: TWITCH_TOKEN or pass token as first argument"),
None,
None,
)
.await?;
foo_client.client.helix.clone_client();
let response = foo_client
.client
.helix
.req_get(
GetStreamsRequest::user_logins(
&[types::UserNameRef::from_str(
&args.next().expect("please provide an username"),
)][..],
),
&token,
)
.await?
.data;
println!("{response:?}");
Ok(())
}
Trait Implementations
sourceimpl<'a> Clone for GetStreamsRequest<'a>
impl<'a> Clone for GetStreamsRequest<'a>
sourcefn clone(&self) -> GetStreamsRequest<'a>
fn clone(&self) -> GetStreamsRequest<'a>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl<'a> Debug for GetStreamsRequest<'a>
impl<'a> Debug for GetStreamsRequest<'a>
sourceimpl Default for GetStreamsRequest<'_>
impl Default for GetStreamsRequest<'_>
sourceimpl<'de: 'a, 'a> Deserialize<'de> for GetStreamsRequest<'a>
impl<'de: 'a, 'a> Deserialize<'de> for GetStreamsRequest<'a>
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
sourceimpl Paginated for GetStreamsRequest<'_>
impl Paginated for GetStreamsRequest<'_>
sourcefn set_pagination(&mut self, cursor: Option<Cursor>)
fn set_pagination(&mut self, cursor: Option<Cursor>)
sourceimpl<'a> PartialEq<GetStreamsRequest<'a>> for GetStreamsRequest<'a>
impl<'a> PartialEq<GetStreamsRequest<'a>> for GetStreamsRequest<'a>
sourcefn eq(&self, other: &GetStreamsRequest<'a>) -> bool
fn eq(&self, other: &GetStreamsRequest<'a>) -> bool
sourceimpl Request for GetStreamsRequest<'_>
impl Request for GetStreamsRequest<'_>
sourceconst PATH: &'static str = "streams"
const PATH: &'static str = "streams"
channels
for Get Channel Informationsourceconst SCOPE: &'static [Scope] = _
const SCOPE: &'static [Scope] = _
twitch_oauth2
only.sourceconst OPT_SCOPE: &'static [Scope] = _
const OPT_SCOPE: &'static [Scope] = _
twitch_oauth2
only.sourcefn query(&self) -> Result<String, SerializeError>
fn query(&self) -> Result<String, SerializeError>
sourcefn get_uri(&self) -> Result<Uri, InvalidUri>
fn get_uri(&self) -> Result<Uri, InvalidUri>
sourcefn get_bare_uri() -> Result<Uri, InvalidUri>
fn get_bare_uri() -> Result<Uri, InvalidUri>
sourceimpl RequestGet for GetStreamsRequest<'_>
impl RequestGet for GetStreamsRequest<'_>
sourcefn create_request(
&self,
token: &str,
client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>
fn create_request(
&self,
token: &str,
client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>
http::Request
from this Request
in your client