Struct twitch_api::helix::predictions::get_predictions::GetPredictionsRequest

#[non_exhaustive]
pub struct GetPredictionsRequest<'a> {
    pub broadcaster_id: Cow<'a, UserIdRef>,
    pub id: Cow<'a, [&'a PredictionIdRef]>,
    pub after: Option<Cow<'a, CursorRef>>,
    pub first: Option<usize>,
}

Available on crate feature helix only.

Query Parameters for Get predictions

get-predictions

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

The broadcaster running Predictions. Provided broadcaster_id must match the user_id in the user OAuth token.

id: Cow<'a, [&'a PredictionIdRef]>

ID of a Prediction. Filters results to one or more specific Predictions. Not providing one or more IDs will return the full list of Predictions for the authenticated channel.

Maximum: 100

after: Option<Cow<'a, CursorRef>>

Cursor for forward pagination

first: Option<usize>

Maximum number of objects to return. Maximum: 20. Default: 20.

Implementations

impl<'a> GetPredictionsRequest<'a>

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

Create a builder for building GetPredictionsRequest. On the builder, call .broadcaster_id(...), .id(...)(optional), .after(...)(optional), .first(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of GetPredictionsRequest.

impl<'a> GetPredictionsRequest<'a>

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

Get information about predictions for this broadcasters channel.

pub fn ids(self, ids: impl Into<Cow<'a, [&'a PredictionIdRef]>>) -> Self

IDs of a Predictions.

Trait Implementations

impl<'a> Clone for GetPredictionsRequest<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for GetPredictionsRequest<'a>

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

Formats the value using the given formatter.

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

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

Should returns the current pagination cursor.

impl<'a> PartialEq<GetPredictionsRequest<'a>> for GetPredictionsRequest<'a>

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

type Response = Vec<Prediction, Global>

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

const PATH: &'static str = "predictions"

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

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

impl<'a> StructuralEq for GetPredictionsRequest<'a>

impl<'a> StructuralPartialEq for GetPredictionsRequest<'a>