Struct tgbot::types::GiveawayWinners

pub struct GiveawayWinners {
    pub chat: Chat,
    pub giveaway_message_id: Integer,
    pub winner_count: Integer,
    pub winners: Vec<User>,
    pub winners_selection_date: Integer,
    pub additional_chat_count: Option<Integer>,
    pub only_new_members: Option<bool>,
    pub premium_subscription_month_count: Option<Integer>,
    pub prize_description: Option<String>,
    pub unclaimed_prize_count: Option<Integer>,
    pub was_refunded: Option<bool>,
}

Represents a message about the completion of a giveaway with public winners.

Fields

chat: Chat

The chat that created the giveaway.

giveaway_message_id: Integer

Identifier of the messsage with the giveaway in the chat.

winner_count: Integer

Total number of winners in the giveaway.

winners: Vec<User>

List of up to 100 winners of the giveaway.

winners_selection_date: Integer

Point in time (Unix timestamp) when winners of the giveaway were selected.

additional_chat_count: Option<Integer>

The number of other chats the user had to join in order to be eligible for the giveaway.

only_new_members: Option<bool>

Whether only users who had joined the chats after the giveaway started were eligible to win.

premium_subscription_month_count: Option<Integer>

The number of months the Telegram Premium subscription won from the giveaway will be active for.

prize_description: Option<String>

Description of additional giveaway prize.

unclaimed_prize_count: Option<Integer>

Number of undistributed prizes.

was_refunded: Option<bool>

Whether the giveaway was canceled because the payment for it was refunded.

Implementations

impl GiveawayWinners

pub fn new<A, B>( chat: A, giveaway_message_id: Integer, winner_count: Integer, winners: B, winners_selection_date: Integer ) -> Self

where A: Into<Chat>, B: IntoIterator<Item = User>,

Creates a new GiveawayWinners.

Arguments

• chat - The chat that created the giveaway.
• giveaway_message_id - Identifier of the messsage with the giveaway in the chat.
• winner_count - Total number of winners in the giveaway.
• winners - List of up to 100 winners of the giveaway.
• winners_selection_date - Point in time (Unix timestamp) when winners of the giveaway were selected.

pub fn with_additional_chat_count(self, value: Integer) -> Self

Sets a new number of additional chats.

Arguments

• value - The number of other chats the user had to join in order to be eligible for the giveaway.

pub fn with_only_new_members(self, value: bool) -> Self

Sets a new value for an only_new_members flag.

Arguments

• value - Whether only users who had joined the chats after the giveaway started were eligible to win.

pub fn with_premium_subscription_month_count(self, value: Integer) -> Self

Sets a new number of premium subscription months.

Arguments

• value - The number of months the Telegram Premium subscription won from the giveaway will be active for.

pub fn with_prize_description<T>(self, value: T) -> Self

where T: Into<String>,

Sets a new prize description.

Arguments

• value - Description of additional giveaway prize.

pub fn with_unclaimed_prize_count(self, value: Integer) -> Self

Sets a new number of unclaimed prizes.

Arguments

• value - Number of undistributed prizes.

pub fn with_was_refunded(self, value: bool) -> Self

Sets a new value for a was_refunded flag.

Arguments

• value - Whether the giveaway was canceled because the payment for it was refunded.

Trait Implementations

impl Clone for GiveawayWinners

fn clone(&self) -> GiveawayWinners

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GiveawayWinners

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GiveawayWinners

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<GiveawayWinners> for ExternalReplyData

fn from(original: GiveawayWinners) -> ExternalReplyData

Converts to this type from the input type.

impl PartialEq for GiveawayWinners

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

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 GiveawayWinners