Struct twitch_api::helix::clips::GetClipsRequest

#[non_exhaustive]
pub struct GetClipsRequest<'a> {
    pub broadcaster_id: Option<Cow<'a, UserIdRef>>,
    pub game_id: Option<Cow<'a, CategoryIdRef>>,
    pub id: Cow<'a, [&'a ClipIdRef]>,
    pub after: Option<Cow<'a, CursorRef>>,
    pub before: Option<Cow<'a, CursorRef>>,
    pub ended_at: Option<Cow<'a, TimestampRef>>,
    pub first: Option<usize>,
    pub started_at: Option<Cow<'a, TimestampRef>>,
}

Available on crate feature helix only.

Query Parameters for Get Clips

get-clips

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: Option<Cow<'a, UserIdRef>>

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<Cow<'a, CategoryIdRef>>

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: Cow<'a, [&'a ClipIdRef]>

ID of the clip being queried. Limit: 100.

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. 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<Cow<'a, CursorRef>>

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<Cow<'a, TimestampRef>>

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<Cow<'a, TimestampRef>>

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

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

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.

impl<'a> GetClipsRequest<'a>

pub fn empty() -> Self

An empty request

Notes

This is not a valid request and needs to be filled out with other fields

Examples found in repository

src/helix/endpoints/clips/get_clips.rs (line 106)

≺ ≻↕

    pub fn broadcaster_id(broadcaster_id: impl types::IntoCow<'a, types::UserIdRef> + 'a) -> Self {
        Self {
            broadcaster_id: Some(broadcaster_id.to_cow()),
            ..Self::empty()
        }
    }

    /// Game for which clips are returned.
    pub fn game_id(game_id: impl types::IntoCow<'a, types::CategoryIdRef> + 'a) -> Self {
        Self {
            game_id: Some(game_id.to_cow()),
            ..Self::empty()
        }
    }

    /// IDs of clips being queried
    pub fn clip_ids(clip_ids: impl Into<Cow<'a, [&'a types::ClipIdRef]>>) -> Self {
        Self {
            id: clip_ids.into(),
            ..Self::empty()
        }
    }

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

Broadcaster for whom clips are returned.

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

Game for which clips are returned.

pub fn clip_ids(clip_ids: impl Into<Cow<'a, [&'a ClipIdRef]>>) -> Self

IDs of clips being queried

pub fn started_at(
    &mut self,
    started_at: impl IntoCow<'a, TimestampRef> + 'a
) -> &mut Self

Ending date/time for the returned clips

pub fn ended_at(
    &mut self,
    ended_at: impl IntoCow<'a, TimestampRef> + 'a
) -> &mut Self

Ending date/time for the returned clips

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

Set amount of results returned per page.

Trait Implementations

impl<'a> Clone for GetClipsRequest<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for GetClipsRequest<'a>

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

Formats the value using the given formatter.

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

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

Should returns the current pagination cursor.

impl<'a> PartialEq<GetClipsRequest<'a>> for GetClipsRequest<'a>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Request for GetClipsRequest<'_>

type Response = Vec<Clip, Global>

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

const PATH: &'static str = "clips"

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

const SCOPE: &'static [Scope] = _

Available on crate feature twitch_oauth2 only.

Scopes needed by this endpoint

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

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

impl<'a> StructuralEq for GetClipsRequest<'a>

impl<'a> StructuralPartialEq for GetClipsRequest<'a>