Struct twitch_api2::helix::videos::GetVideosRequest [−][src]
#[non_exhaustive]pub struct GetVideosRequest { pub id: Vec<VideoId>, pub user_id: Option<UserId>, pub game_id: Option<CategoryId>, pub after: Option<Cursor>, pub before: Option<Cursor>, pub first: Option<usize>, pub language: Option<String>, pub period: Option<VideoPeriod>, pub sort: Option<Sort>, pub type_: Option<VideoTypeFilter>, }
helix
only.Query Parameters for Get Videos
Fields (Non-exhaustive)
Struct {{ .. }}
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.id: Vec<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<UserId>
ID of the user who owns the video.
game_id: Option<CategoryId>
ID of the game the video is of.
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>
Number of values to be returned when getting videos by user or game ID. Limit: 100. Default: 20.
language: Option<String>
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 GetVideosRequest
[src]
impl GetVideosRequest
[src]pub fn builder(
) -> GetVideosRequestBuilder<((), (), (), (), (), (), (), (), (), ())>
[src]
) -> GetVideosRequestBuilder<((), (), (), (), (), (), (), (), (), ())>
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
.
Trait Implementations
impl Clone for GetVideosRequest
[src]
impl Clone for GetVideosRequest
[src]fn clone(&self) -> GetVideosRequest
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'de> Deserialize<'de> for GetVideosRequest
[src]
impl<'de> Deserialize<'de> for GetVideosRequest
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Paginated for GetVideosRequest
[src]
impl Paginated for GetVideosRequest
[src]fn set_pagination(&mut self, cursor: Option<Cursor>)
[src]
impl PartialEq<GetVideosRequest> for GetVideosRequest
[src]
impl PartialEq<GetVideosRequest> for GetVideosRequest
[src]fn eq(&self, other: &GetVideosRequest) -> bool
[src]
fn ne(&self, other: &GetVideosRequest) -> bool
[src]
impl Request for GetVideosRequest
[src]
impl Request for GetVideosRequest
[src]type Response = Vec<Video>
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 GetVideosRequest
[src]
impl RequestGet for GetVideosRequest
[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 GetVideosRequest
[src]
impl Serialize for GetVideosRequest
[src]impl StructuralPartialEq for GetVideosRequest
[src]
impl StructuralPartialEq for GetVideosRequest
[src]Auto Trait Implementations
impl RefUnwindSafe for GetVideosRequest
impl RefUnwindSafe for GetVideosRequest
impl Send for GetVideosRequest
impl Send for GetVideosRequest
impl Sync for GetVideosRequest
impl Sync for GetVideosRequest
impl Unpin for GetVideosRequest
impl Unpin for GetVideosRequest
impl UnwindSafe for GetVideosRequest
impl UnwindSafe for GetVideosRequest
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>,