Struct botapi::gen_types::PollBuilder

pub struct PollBuilder {

    pub id: String,
    pub question: String,
    pub question_entities: Option<Vec<MessageEntity>>,
    pub options: Vec<PollOption>,
    pub total_voter_count: i64,
    pub is_closed: bool,
    pub is_anonymous: bool,
    pub tg_type: String,
    pub allows_multiple_answers: bool,
    pub correct_option_id: Option<i64>,
    pub explanation: Option<String>,
    pub explanation_entities: Option<Vec<MessageEntity>>,
    pub open_period: Option<i64>,
    pub close_date: Option<i64>,
}

This object contains information about a poll.

Fields

id: String

Unique poll identifier

question: String

Poll question, 1-300 characters

question_entities: Option<Vec<MessageEntity>>

Optional. Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions

options: Vec<PollOption>

List of poll options

total_voter_count: i64

Total number of users that voted in the poll

is_closed: bool

True, if the poll is closed

is_anonymous: bool

True, if the poll is anonymous

tg_type: String

Poll type, currently can be “regular” or “quiz”

allows_multiple_answers: bool

True, if the poll allows multiple answers

correct_option_id: Option<i64>

Optional. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.

explanation: Option<String>

Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters

explanation_entities: Option<Vec<MessageEntity>>

Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation

open_period: Option<i64>

Optional. Amount of time in seconds the poll will be active after creation

close_date: Option<i64>

Optional. Point in time (Unix timestamp) when the poll will be automatically closed

Implementations

impl PollBuilder

pub fn new( id: String, question: String, options: Vec<PollOption>, total_voter_count: i64, is_closed: bool, is_anonymous: bool, allows_multiple_answers: bool, ) -> Self

pub fn set_id(self, id: String) -> Self

Unique poll identifier

pub fn set_question(self, question: String) -> Self

Poll question, 1-300 characters

pub fn set_question_entities( self, question_entities: Vec<MessageEntity>, ) -> Self

Optional. Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions

pub fn set_options(self, options: Vec<PollOption>) -> Self

List of poll options

pub fn set_total_voter_count(self, total_voter_count: i64) -> Self

Total number of users that voted in the poll

pub fn set_is_closed(self, is_closed: bool) -> Self

True, if the poll is closed

pub fn set_is_anonymous(self, is_anonymous: bool) -> Self

True, if the poll is anonymous

pub fn set_type(self, tg_type: String) -> Self

Poll type, currently can be “regular” or “quiz”

pub fn set_allows_multiple_answers(self, allows_multiple_answers: bool) -> Self

True, if the poll allows multiple answers

pub fn set_correct_option_id(self, correct_option_id: i64) -> Self

Optional. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.

pub fn set_explanation(self, explanation: String) -> Self

Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters

pub fn set_explanation_entities( self, explanation_entities: Vec<MessageEntity>, ) -> Self

Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation

pub fn set_open_period(self, open_period: i64) -> Self

Optional. Amount of time in seconds the poll will be active after creation

pub fn set_close_date(self, close_date: i64) -> Self

Optional. Point in time (Unix timestamp) when the poll will be automatically closed

pub fn build(self) -> Poll

Trait Implementations

impl Clone for PollBuilder

fn clone(&self) -> PollBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PollBuilder

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

Formats the value using the given formatter.

impl Default for PollBuilder

fn default() -> PollBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PollBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for PollBuilder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PollBuilder

fn cmp(&self, other: &PollBuilder) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for PollBuilder

fn eq(&self, other: &PollBuilder) -> 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 PartialOrd for PollBuilder

fn partial_cmp(&self, other: &PollBuilder) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PollBuilder

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PollBuilder

impl StructuralPartialEq for PollBuilder