Struct twitch_api2::helix::predictions::end_prediction::EndPredictionBody

#[non_exhaustive]
pub struct EndPredictionBody {
    pub broadcaster_id: UserId,
    pub id: PredictionId,
    pub status: PredictionStatus,
    pub winning_outcome_id: Option<PredictionId>,
}

Available on crate feature helix only.

Body Parameters for End Prediction

end-prediction

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: UserId

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

id: PredictionId

ID of the prediction.

status: PredictionStatus

The Prediction status to be set. Valid values:

RESOLVED: A winning outcome has been chosen and the Channel Points have been distributed to the users who predicted the correct outcome. CANCELED: The Prediction has been canceled and the Channel Points have been refunded to participants. LOCKED: The Prediction has been locked and viewers can no longer make predictions.

winning_outcome_id: Option<PredictionId>

ID of the winning outcome for the Prediction. This parameter is required if status is being set to RESOLVED.

Implementations

impl EndPredictionBody

pub fn builder() -> EndPredictionBodyBuilder<((), (), (), ())>

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

Trait Implementations

impl Clone for EndPredictionBody

fn clone(&self) -> EndPredictionBody

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EndPredictionBody

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EndPredictionBody

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<EndPredictionBody> for EndPredictionBody

fn eq(&self, other: &EndPredictionBody) -> bool

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

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

This method tests for !=.

impl Serialize for EndPredictionBody

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EndPredictionBody