Struct tgbot::types::KeyboardButtonRequestUsers

pub struct KeyboardButtonRequestUsers { /* private fields */ }

Represents a criteria used to request a suitable user.

The identifier of the selected user will be shared with the bot when the corresponding button is pressed.

More about requesting users

Implementations

impl KeyboardButtonRequestUsers

pub fn new(request_id: Integer) -> Self

Creates a new KeyboardButtonRequestUsers.

Arguments

• request_id - Signed 32-bit identifier of the request, which will be received back in the crate::types::MessageDataUsersShared object; must be unique within the message.

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

Sets a new max quantity

Arguments

• value - The maximum number of users to be selected; 1-10; default - 1.

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

Sets a new value for the request_name flag.

Arguments

• value - Whether to request the users’ first and last name.

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

Sets a new value for the request_photo flag.

Arguments

• value - Whether to request users’ photo.

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

Sets a new value for the request_username flag.

Arguments

• value - Whether to request users’ username.

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

Sets a new value for a user_is_bot flag.

Arguments

• value - Indicates whether to request a bot or a regular user.

If not specified, no additional restrictions are applied.

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

Sets a new value for a user_is_premium flag.

Arguments

• value - Indicates whether to request a premium user.

If not specified, no additional restrictions are applied.

Trait Implementations

impl Clone for KeyboardButtonRequestUsers

fn clone(&self) -> KeyboardButtonRequestUsers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardButtonRequestUsers

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyboardButtonRequestUsers

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for KeyboardButtonRequestUsers

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for KeyboardButtonRequestUsers

impl StructuralPartialEq for KeyboardButtonRequestUsers