Struct tg_flows::Poll

pub struct Poll {

    pub id: String,
    pub question: String,
    pub options: Vec<PollOption>,
    pub is_closed: bool,
    pub total_voter_count: i32,
    pub is_anonymous: bool,
    pub poll_type: PollType,
    pub allows_multiple_answers: bool,
    pub correct_option_id: Option<u8>,
    pub explanation: Option<String>,
    pub explanation_entities: Option<Vec<MessageEntity>>,
    pub open_period: Option<u16>,
    pub close_date: Option<DateTime<Utc>>,
}

This object contains information about a poll.

The official docs.

Fields

id: String

Unique poll identifier.

question: String

Poll question, 1-255 characters.

options: Vec<PollOption>

List of poll options.

is_closed: bool

true, if the poll is closed.

total_voter_count: i32

Total number of users that voted in the poll

is_anonymous: bool

True, if the poll is anonymous

poll_type: PollType

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

allows_multiple_answers: bool

True, if the poll allows multiple answers

correct_option_id: Option<u8>

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>

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

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

open_period: Option<u16>

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

close_date: Option<DateTime<Utc>>

Point in time when the poll will be automatically closed.

Implementations

impl Poll

pub fn mentioned_users(&self) -> impl Iterator<Item = &User>

Returns all users that are “contained” in this Poll structure.

This might be useful to track information about users.

Note that this function can return duplicate users.

Trait Implementations

impl Clone for Poll

fn clone(&self) -> Poll

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Poll

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Poll

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

Deserialize this value from the given Serde deserializer.

impl Hash for Poll

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 PartialEq<Poll> for Poll

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

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 Poll

impl StructuralEq for Poll

impl StructuralPartialEq for Poll