Struct twitch_api::helix::polls::EndPollBody

#[non_exhaustive]
pub struct EndPollBody<'a> {
    pub broadcaster_id: Cow<'a, UserIdRef>,
    pub id: Cow<'a, PollIdRef>,
    pub status: PollStatus,
}

Available on crate feature helix only.

Body Parameters for End Poll

end-poll

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 polls. Provided broadcaster_id must match the user_id in the user OAuth token.

id: Cow<'a, PollIdRef>

ID of the poll.

status: PollStatus

The poll status to be set.

Valid values: TERMINATED: End the poll manually, but allow it to be viewed publicly. ARCHIVED: End the poll manually and do not allow it to be viewed publicly.

Implementations

impl<'a> EndPollBody<'a>

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

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

impl<'a> EndPollBody<'a>

pub fn new(
    broadcaster_id: impl IntoCow<'a, UserIdRef> + 'a,
    id: impl IntoCow<'a, PollIdRef> + 'a,
    status: PollStatus
) -> Self

End a poll that is currently active.

Trait Implementations

impl<'a> Clone for EndPollBody<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for EndPollBody<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for EndPollBody<'a>

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

Deserialize this value from the given Serde deserializer.

impl<'a> PartialEq<EndPollBody<'a>> for EndPollBody<'a>

fn eq(&self, other: &EndPollBody<'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<'a> Serialize for EndPollBody<'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 EndPollBody<'a>

impl<'a> StructuralEq for EndPollBody<'a>

impl<'a> StructuralPartialEq for EndPollBody<'a>