Struct tgbot::types::LoginUrl

pub struct LoginUrl { /* private fields */ }

Represents a parameter of the inline keyboard button used to automatically authorize a user.

Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram.

Implementations

impl LoginUrl

pub fn new<T>(url: T) -> Self

where T: Into<String>,

Creates a new LoginUrl.

Arguments

• value - An HTTP URL to be opened with user authorization data added to the query string when the button is pressed.

If the user refuses to provide authorization data, the original URL without information about the user will be opened.

The data added is the same as described in Receiving authorization data.

Notes

You must always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization.

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

where T: Into<String>,

Sets a new username of a bot.

Arguments

• value - The username of the bot, which will be used for user authorization.

See Setting up a bot for more details. If not specified, the current bot username will be assumed. The url domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details.

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

where T: Into<String>,

Sets a new forward text.

Arguments

• value - New text of the button in forwarded messages.

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

Sets a new value for a request_write_access flag.

Arguments

• value - Indicates whether to request the permission for your bot to send messages to the user.

Trait Implementations

impl Clone for LoginUrl

fn clone(&self) -> LoginUrl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LoginUrl

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LoginUrl

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<T> for LoginUrl

where T: Into<String>,

fn from(url: T) -> Self

Converts to this type from the input type.

impl PartialEq for LoginUrl

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

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

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 LoginUrl