Struct twitch_api::helix::channels::GetVipsRequest
source · [−]#[non_exhaustive]pub struct GetVipsRequest<'a> {
pub broadcaster_id: Cow<'a, UserIdRef>,
pub user_id: Cow<'a, [&'a UserIdRef]>,
pub first: Option<usize>,
pub after: Option<Cow<'a, CursorRef>>,
}
helix
only.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.broadcaster_id: Cow<'a, UserIdRef>
The ID of the broadcaster whose list of VIPs you want to get.
user_id: Cow<'a, [&'a UserIdRef]>
Filters the list for specific VIPs. To specify more than one user, include the user_id parameter for each user to get. For example, &user_id=1234&user_id=5678. The maximum number of IDs that you may specify is 100. Ignores those users in the list that aren’t VIPs.
first: Option<usize>
The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100. The default is 20.
after: Option<Cow<'a, CursorRef>>
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read more.
Implementations
sourceimpl<'a> GetVipsRequest<'a>
impl<'a> GetVipsRequest<'a>
sourcepub fn builder() -> GetVipsRequestBuilder<'a, ((), (), (), ())>
pub fn builder() -> GetVipsRequestBuilder<'a, ((), (), (), ())>
Create a builder for building GetVipsRequest
.
On the builder, call .broadcaster_id(...)
, .user_id(...)
(optional), .first(...)
(optional), .after(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of GetVipsRequest
.
sourceimpl<'a> GetVipsRequest<'a>
impl<'a> GetVipsRequest<'a>
sourcepub fn broadcaster_id(broadcaster_id: impl IntoCow<'a, UserIdRef> + 'a) -> Self
pub fn broadcaster_id(broadcaster_id: impl IntoCow<'a, UserIdRef> + 'a) -> Self
Get channel VIPs in channel
Examples found in repository?
816 817 818 819 820 821 822 823 824 825 826 827 828 829
pub fn get_vips_in_channel<'b: 'a, T>(
&'a self,
broadcaster_id: impl types::IntoCow<'b, types::UserIdRef> + 'b,
token: &'a T,
) -> std::pin::Pin<
Box<dyn futures::Stream<Item = Result<helix::channels::Vip, ClientError<'a, C>>> + 'a>,
>
where
T: TwitchToken + Send + Sync + ?Sized,
{
let req = helix::channels::GetVipsRequest::broadcaster_id(broadcaster_id);
make_stream(req, token, self, std::collections::VecDeque::from)
}
Trait Implementations
sourceimpl<'a> Clone for GetVipsRequest<'a>
impl<'a> Clone for GetVipsRequest<'a>
sourcefn clone(&self) -> GetVipsRequest<'a>
fn clone(&self) -> GetVipsRequest<'a>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl<'a> Debug for GetVipsRequest<'a>
impl<'a> Debug for GetVipsRequest<'a>
sourceimpl<'de: 'a, 'a> Deserialize<'de> for GetVipsRequest<'a>
impl<'de: 'a, 'a> Deserialize<'de> for GetVipsRequest<'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 GetVipsRequest<'_>
impl Paginated for GetVipsRequest<'_>
sourcefn set_pagination(&mut self, cursor: Option<Cursor>)
fn set_pagination(&mut self, cursor: Option<Cursor>)
sourceimpl<'a> PartialEq<GetVipsRequest<'a>> for GetVipsRequest<'a>
impl<'a> PartialEq<GetVipsRequest<'a>> for GetVipsRequest<'a>
sourcefn eq(&self, other: &GetVipsRequest<'a>) -> bool
fn eq(&self, other: &GetVipsRequest<'a>) -> bool
sourceimpl Request for GetVipsRequest<'_>
impl Request for GetVipsRequest<'_>
sourceconst PATH: &'static str = "channels/vips"
const PATH: &'static str = "channels/vips"
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 GetVipsRequest<'_>
impl RequestGet for GetVipsRequest<'_>
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 clientsourcefn parse_response<B: Into<Bytes>>(
request: Option<Self>,
uri: &Uri,
response: Response<B>
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>where
Self: Sized,
fn parse_response<B: Into<Bytes>>(
request: Option<Self>,
uri: &Uri,
response: Response<B>
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>where
Self: Sized,
sourcefn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>where
Self: Sized,
fn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>where
Self: Sized,
sourceimpl<'a> Serialize for GetVipsRequest<'a>
impl<'a> Serialize for GetVipsRequest<'a>
impl<'a> Eq for GetVipsRequest<'a>
impl<'a> StructuralEq for GetVipsRequest<'a>
impl<'a> StructuralPartialEq for GetVipsRequest<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for GetVipsRequest<'a>
impl<'a> Send for GetVipsRequest<'a>
impl<'a> Sync for GetVipsRequest<'a>
impl<'a> Unpin for GetVipsRequest<'a>
impl<'a> UnwindSafe for GetVipsRequest<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.