Struct GetVipsRequest

#[non_exhaustive]
pub struct GetVipsRequest<'a> {
    pub broadcaster_id: Cow<'a, UserIdRef>,
    pub user_id: Collection<'a, UserId>,
    pub first: Option<usize>,
    pub after: Option<Cow<'a, CursorRef>>,
}

Available on crate feature helix only.

Query Parameters for Get VIPs

get-vips

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.

broadcaster_id: Cow<'a, UserIdRef>

The ID of the broadcaster whose list of VIPs you want to get.

user_id: Collection<'a, UserId>

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

impl<'a> GetVipsRequest<'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.

impl<'a> GetVipsRequest<'a>

pub fn broadcaster_id(broadcaster_id: impl IntoCow<'a, UserIdRef> + 'a) -> Self

Get channel VIPs in channel

Examples

use twitch_api::helix::channels::GetVipsRequest;
let request = GetVipsRequest::broadcaster_id("1337");

pub const fn first(self, first: usize) -> Self

Set amount of results returned per page.

Examples

use twitch_api::helix::channels::GetVipsRequest;
let request = GetVipsRequest::broadcaster_id("1234").first(100);

pub fn user_ids(self, user_ids: impl Into<Collection<'a, UserId>>) -> Self

Filter response with these IDs

Examples

use twitch_api::helix::channels::GetVipsRequest;

let user_ids: &[&twitch_types::UserIdRef] = &["1234".into()];
let request = GetVipsRequest::broadcaster_id("1337").user_ids(user_ids);

Trait Implementations

impl<'a> Clone for GetVipsRequest<'a>

fn clone(&self) -> GetVipsRequest<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for GetVipsRequest<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for GetVipsRequest<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Paginated for GetVipsRequest<'_>

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

Should returns the current pagination cursor.

impl<'a> PartialEq for GetVipsRequest<'a>

fn eq(&self, other: &GetVipsRequest<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Request for GetVipsRequest<'_>

const PATH: &'static str = "channels/vips"

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

const SCOPE: Validator

Available on crate feature twitch_oauth2 only.

Scopes needed for this endpoint

type Response = Vec<Vip>

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

const OPT_SCOPE: &'static [Scope] = _

Available on crate feature twitch_oauth2 only.

Optional scopes needed by this endpoint

fn query(&self) -> Result<String, SerializeError>

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 GetVipsRequest<'_>

fn create_request( &self, token: &str, client_id: &str, ) -> Result<Request<Bytes>, CreateRequestError>

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

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,

Parse response.

fn parse_inner_response( request: Option<Self>, uri: &Uri, response: &str, status: StatusCode, ) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>

where Self: Sized,

Parse a response string into the response.

impl<'a> Serialize for GetVipsRequest<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for GetVipsRequest<'a>

impl<'a> StructuralPartialEq for GetVipsRequest<'a>