Struct twitch_api2::helix::clips::get_clips::GetClipsRequest [−][src]
#[non_exhaustive]pub struct GetClipsRequest { pub broadcaster_id: Option<UserId>, pub game_id: Option<CategoryId>, pub id: Vec<String>, pub after: Option<Cursor>, pub before: Option<Cursor>, pub ended_at: Option<Timestamp>, pub first: Option<usize>, pub started_at: Option<Timestamp>, }
helix
only.Fields (Non-exhaustive)
Struct {{ .. }}
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.broadcaster_id: Option<UserId>
ID of the broadcaster for whom clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count.
game_id: Option<CategoryId>
ID of the game for which clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count.
id: Vec<String>
ID of the clip being queried. Limit: 100.
after: Option<Cursor>
Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. This applies only to queries specifying broadcaster_id or game_id. 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. This applies only to queries specifying broadcaster_id or game_id. The cursor value specified here is from the pagination response field of a prior query.
ended_at: Option<Timestamp>
Ending date/time for returned clips, in RFC3339 format. (Note that the seconds value is ignored.) If this is specified, started_at also must be specified; otherwise, the time period is ignored.
first: Option<usize>
Maximum number of objects to return. Maximum: 100. Default: 20.
started_at: Option<Timestamp>
Starting date/time for returned clips, in RFC3339 format. (Note that the seconds value is ignored.) If this is specified, ended_at also should be specified; otherwise, the ended_at date/time will be 1 week after the started_at value.
Implementations
impl GetClipsRequest
[src]
impl GetClipsRequest
[src]pub fn builder() -> GetClipsRequestBuilder<((), (), (), (), (), (), (), ())>
[src]
Create a builder for building GetClipsRequest
.
On the builder, call .broadcaster_id(...)
(optional), .game_id(...)
(optional), .id(...)
(optional), .after(...)
(optional), .before(...)
(optional), .ended_at(...)
(optional), .first(...)
(optional), .started_at(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of GetClipsRequest
.
Trait Implementations
impl Clone for GetClipsRequest
[src]
impl Clone for GetClipsRequest
[src]fn clone(&self) -> GetClipsRequest
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'de> Deserialize<'de> for GetClipsRequest
[src]
impl<'de> Deserialize<'de> for GetClipsRequest
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Paginated for GetClipsRequest
[src]
impl Paginated for GetClipsRequest
[src]fn set_pagination(&mut self, cursor: Option<Cursor>)
[src]
impl PartialEq<GetClipsRequest> for GetClipsRequest
[src]
impl PartialEq<GetClipsRequest> for GetClipsRequest
[src]fn eq(&self, other: &GetClipsRequest) -> bool
[src]
fn ne(&self, other: &GetClipsRequest) -> bool
[src]
impl Request for GetClipsRequest
[src]
impl Request for GetClipsRequest
[src]type Response = Vec<Clip>
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 GetClipsRequest
[src]
impl RequestGet for GetClipsRequest
[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 GetClipsRequest
[src]
impl Serialize for GetClipsRequest
[src]impl StructuralPartialEq for GetClipsRequest
[src]
impl StructuralPartialEq for GetClipsRequest
[src]Auto Trait Implementations
impl RefUnwindSafe for GetClipsRequest
impl RefUnwindSafe for GetClipsRequest
impl Send for GetClipsRequest
impl Send for GetClipsRequest
impl Sync for GetClipsRequest
impl Sync for GetClipsRequest
impl Unpin for GetClipsRequest
impl Unpin for GetClipsRequest
impl UnwindSafe for GetClipsRequest
impl UnwindSafe for GetClipsRequest
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>,