Struct tg_flows::User

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

This object represents a Telegram user or bot.

The official docs.

Fields

id: UserId

Unique identifier for this user or bot.

is_bot: bool

true, if this user is a bot.

first_name: String

User‘s or bot’s first name.

last_name: Option<String>

User‘s or bot’s last name.

username: Option<String>

User‘s or bot’s username.

language_code: Option<String>

IETF language tag of the user’s language.

is_premium: bool

true, if this user is a Telegram Premium user.

added_to_attachment_menu: bool

true, if this user added the bot to the attachment menu.

Implementations

impl User

pub fn full_name(&self) -> String

Returns full name of this user, ie first and last names joined with a space.

pub fn mention(&self) -> Option<String>

Returns a username mention of this user. Returns None if self.username.is_none().

pub fn url(&self) -> Url

Returns an URL that links to this user in the form of tg://user/?id=<...>.

pub fn tme_url(&self) -> Option<Url>

Returns an URL that links to this user in the form of t.me/<...>. Returns None if self.username.is_none().

pub fn preferably_tme_url(&self) -> Url

Returns an URL that links to this user in the form of t.me/<...> or tg://user/?id=<...>, preferring t.me one when possible.

pub fn is_anonymous(&self) -> bool

Returns true if this is the special user used by telegram bot API to denote an anonymous user that sends messages on behalf of a group.

pub fn is_channel(&self) -> bool

Returns true if this is the special user used by telegram bot API to denote an anonymous user that sends messages on behalf of a channel.

pub fn is_telegram(&self) -> bool

Returns true if this is the special user used by telegram itself.

It is sometimes also used as a fallback, for example when a channel post is automatically forwarded to a group, bots in a group will get a message where from is the Telegram user.

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a copy of the value.

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 Hash for User

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

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

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 User

impl StructuralEq for User

impl StructuralPartialEq for User