Struct CreatePoll

pub struct CreatePoll<Stage: Sealed> { /* private fields */ }

Implementations

impl CreatePoll<NeedsQuestion>

pub fn new() -> Self

Creates a builder for creating a Poll.

This must be transitioned through in order, to provide all required fields.

use serenity::builder::{CreateMessage, CreatePoll, CreatePollAnswer};

let poll = CreatePoll::new()
    .question("Cats or Dogs?")
    .answers(vec![
        CreatePollAnswer::new().emoji("🐱".to_string()).text("Cats!"),
        CreatePollAnswer::new().emoji("🐶".to_string()).text("Dogs!"),
        CreatePollAnswer::new().text("Neither..."),
    ])
    .duration(std::time::Duration::from_secs(60 * 60 * 24 * 7));

let message = CreateMessage::new().poll(poll);

pub fn question(self, text: impl Into<String>) -> CreatePoll<NeedsAnswers>

Sets the question to be polled.

impl CreatePoll<NeedsAnswers>

pub fn answers( self, answers: Vec<CreatePollAnswer>, ) -> CreatePoll<NeedsDuration>

Sets the answers that can be picked from.

impl CreatePoll<NeedsDuration>

pub fn duration(self, duration: Duration) -> CreatePoll<Ready>

Sets the duration for the Poll to run for.

This must be less than a week, and will be rounded to hours towards zero.

impl<Stage: Sealed> CreatePoll<Stage>

pub fn layout_type(self, layout_type: PollLayoutType) -> Self

Sets the layout type for the Poll to take.

This is currently only ever PollLayoutType::Default, and is optional.

pub fn allow_multiselect(self) -> Self

Allows users to select multiple answers for the Poll.

Trait Implementations

impl<Stage: Clone + Sealed> Clone for CreatePoll<Stage>

fn clone(&self) -> CreatePoll<Stage>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Stage: Debug + Sealed> Debug for CreatePoll<Stage>

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

Formats the value using the given formatter.

impl Default for CreatePoll<NeedsQuestion>

fn default() -> Self

See the documentation of Self::new.

impl<Stage: Sealed> Serialize for CreatePoll<Stage>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.