Struct twitch_api2::helix::videos::get_videos::GetVideosRequest
source · [−]#[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.Expand description
Query Parameters for Get Videos
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.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
sourceimpl GetVideosRequest
impl GetVideosRequest
sourcepub fn builder(
) -> GetVideosRequestBuilder<((), (), (), (), (), (), (), (), (), ())>
pub fn builder(
) -> 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
sourceimpl Clone for GetVideosRequest
impl Clone for GetVideosRequest
sourcefn clone(&self) -> GetVideosRequest
fn clone(&self) -> GetVideosRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for GetVideosRequest
impl Debug for GetVideosRequest
sourceimpl<'de> Deserialize<'de> for GetVideosRequest
impl<'de> Deserialize<'de> for GetVideosRequest
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>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Paginated for GetVideosRequest
impl Paginated for GetVideosRequest
sourcefn set_pagination(&mut self, cursor: Option<Cursor>)
fn set_pagination(&mut self, cursor: Option<Cursor>)
Should returns the current pagination cursor. Read more
sourceimpl PartialEq<GetVideosRequest> for GetVideosRequest
impl PartialEq<GetVideosRequest> for GetVideosRequest
sourcefn eq(&self, other: &GetVideosRequest) -> bool
fn eq(&self, other: &GetVideosRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &GetVideosRequest) -> bool
fn ne(&self, other: &GetVideosRequest) -> bool
This method tests for !=
.
sourceimpl Request for GetVideosRequest
impl Request for GetVideosRequest
sourceconst PATH: &'static str = "videos"
const PATH: &'static str = "videos"
The path to the endpoint relative to the helix root. eg. channels
for Get Channel Information
sourceconst SCOPE: &'static [Scope] = &[]
const SCOPE: &'static [Scope] = &[]
twitch_oauth2
only.Scopes needed by this endpoint
sourceconst OPT_SCOPE: &'static [Scope] = &[]
const OPT_SCOPE: &'static [Scope] = &[]
twitch_oauth2
only.Optional scopes needed by this endpoint
sourcefn query(&self) -> Result<String, SerializeError>
fn query(&self) -> Result<String, SerializeError>
Defines layout of the url parameters.
sourcefn get_uri(&self) -> Result<Uri, InvalidUri>
fn get_uri(&self) -> Result<Uri, InvalidUri>
Returns full URI for the request, including query parameters.
sourcefn get_bare_uri() -> Result<Uri, InvalidUri>
fn get_bare_uri() -> Result<Uri, InvalidUri>
Returns bare URI for the request, NOT including query parameters.
sourceimpl RequestGet for GetVideosRequest
impl RequestGet for GetVideosRequest
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>
Create a http::Request
from this Request
in your client
sourcefn 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,
Parse response. Read more
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,
Parse a response string into the response.
sourceimpl Serialize for GetVideosRequest
impl Serialize for GetVideosRequest
impl StructuralPartialEq for GetVideosRequest
Auto Trait Implementations
impl RefUnwindSafe for GetVideosRequest
impl Send for GetVideosRequest
impl Sync for GetVideosRequest
impl Unpin for GetVideosRequest
impl UnwindSafe for GetVideosRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more