Struct GetVideosRequest

#[non_exhaustive]
pub struct GetVideosRequest<'a> {
    pub id: Collection<'a, VideoId>,
    pub user_id: Option<Cow<'a, UserIdRef>>,
    pub game_id: Option<Cow<'a, CategoryIdRef>>,
    pub after: Option<Cow<'a, CursorRef>>,
    pub before: Option<Cow<'a, CursorRef>>,
    pub first: Option<usize>,
    pub language: Option<Cow<'a, str>>,
    pub period: Option<VideoPeriod>,
    pub sort: Option<Sort>,
    pub type_: Option<VideoTypeFilter>,
}

Available on crate feature helix only.

Query Parameters for Get Videos

get-videos

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.

id: Collection<'a, VideoId>

ID of the video being queried. Limit: 100. If this is specified, you cannot use any of the optional query parameters below.

user_id: Option<Cow<'a, UserIdRef>>

ID of the user who owns the video.

game_id: Option<Cow<'a, CategoryIdRef>>

ID of the game the video is of.

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>

Number of values to be returned when getting videos by user or game ID. Limit: 100. Default: 20.

language: Option<Cow<'a, str>>

Language of the video being queried. Limit: 1.

period: Option<VideoPeriod>

Period during which the video was created. Valid values: “all”, “day”, “week”, “month”. Default: “all”.

sort: Option<Sort>

Sort order of the videos. Valid values: “time”, “trending”, “views”. Default: “time”.

type_: Option<VideoTypeFilter>

Type of video. Valid values: “all”, “upload”, “archive”, “highlight”. Default: “all”.

Implementations

impl<'a> GetVideosRequest<'a>

pub fn builder() -> GetVideosRequestBuilder<'a, ((), (), (), (), (), (), (), (), (), ())>

Create a builder for building GetVideosRequest. On the builder, call .id(...)(optional), .user_id(...)(optional), .game_id(...)(optional), .after(...)(optional), .before(...)(optional), .first(...)(optional), .language(...)(optional), .period(...)(optional), .sort(...)(optional), .type_(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of GetVideosRequest.

impl<'a> GetVideosRequest<'a>

pub fn ids(ids: impl Into<Collection<'a, VideoId>>) -> Self

IDs of the videos being queried.

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

ID of the user who owns the video.

pub fn game_id(game_id: impl IntoCow<'a, CategoryIdRef> + 'a) -> Self

ID of the game the video is of.

Trait Implementations

impl<'a> Clone for GetVideosRequest<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for GetVideosRequest<'a>

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

Formats the value using the given formatter.

impl<'a> Default for GetVideosRequest<'a>

fn default() -> GetVideosRequest<'a>

Returns the “default value” for a type.

impl<'de: 'a, 'a> Deserialize<'de> for GetVideosRequest<'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 GetVideosRequest<'_>

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

Should returns the current pagination cursor.

impl<'a> PartialEq for GetVideosRequest<'a>

fn eq(&self, other: &GetVideosRequest<'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 GetVideosRequest<'_>

const PATH: &'static str = "videos"

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

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

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 GetVideosRequest<'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 GetVideosRequest<'a>

impl<'a> StructuralPartialEq for GetVideosRequest<'a>