Struct User

pub struct User {
    pub first_name: String,
    pub id: UserPeerId,
    pub is_bot: bool,
    pub added_to_attachment_menu: Option<bool>,
    pub is_premium: Option<bool>,
    pub language_code: Option<String>,
    pub last_name: Option<String>,
    pub username: Option<UserUsername>,
}

Represents a user.

Fields

first_name: String

First name of the user.

id: UserPeerId

Unique identifier of the user.

is_bot: bool

Indicates whether the user is a bot.

added_to_attachment_menu: Option<bool>

Indicates whether the user added the bot to the attachment menu.

is_premium: Option<bool>

Indicates whether the user is a Telegram Premium user.

language_code: Option<String>

IETF language tag of the user’s language.

last_name: Option<String>

Last name of the user.

username: Option<UserUsername>

Username of the user.

Implementations

impl User

pub fn new<A, B>(id: A, first_name: B, is_bot: bool) -> Self

where A: Into<UserPeerId>, B: Into<String>,

Creates a new User.

Arguments

• id - Unique identifier of the user.
• first_name - First name of the user.
• is_bot - Indicates whether the user is a bot.

pub fn get_full_name(&self) -> String

Returns the full name of the user (first name + last name).

pub fn get_link(&self) -> String

Returns the link to the user (tg://user?id=xxx).

These links will work only if they are used inside an inline link. For example, they will not work, when used in an inline keyboard button or in a message text.

pub fn get_link_mention( &self, parse_mode: ParseMode, ) -> Result<String, MentionError>

Returns the mention for the user.

Arguments

• parse_mode - A parse mode for formatting the mention.

These mentions are only guaranteed to work if the user has contacted the bot in the past, has sent a callback query to the bot via inline button or is a member in the group where he was mentioned.

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

Sets a new value for the added_to_attachment_menu flag.

Arguments

• value - Indicates whether the user added the bot to the attachment menu.

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

Sets a new value for the is_premium flag.

Arguments

• value - Indicates whether the user is a Telegram Premium user.

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

where T: Into<String>,

Sets a new language code.

Arguments

• value - Language code.

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

where T: Into<String>,

Sets a new last name.

Arguments

• value - Last name.

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

where T: Into<UserUsername>,

Sets a new username.

Arguments

• value - Username.

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for User

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for User

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<User> for MessageSender

fn from(value: User) -> Self

Converts to this type from the input type.

impl From<User> for PollAnswerVoter

fn from(value: User) -> Self

Converts to this type from the input type.

impl PartialEq for User

fn eq(&self, other: &User) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for User

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for User

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 User