Struct botapi::gen_types::EncryptedPassportElement

pub struct EncryptedPassportElement {
    pub tg_type: String,
    pub data: Option<String>,
    pub phone_number: Option<String>,
    pub email: Option<String>,
    pub files: Option<Vec<PassportFile>>,
    pub front_side: Option<BoxWrapper<Unbox<PassportFile>>>,
    pub reverse_side: Option<BoxWrapper<Unbox<PassportFile>>>,
    pub selfie: Option<BoxWrapper<Unbox<PassportFile>>>,
    pub translation: Option<Vec<PassportFile>>,
    pub hash: String,
}

Describes documents or other Telegram Passport elements shared with the bot by the user.

Fields

tg_type: String

Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.

data: Option<String>

Optional. Base64-encoded encrypted Telegram Passport element data provided by the user; available only for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials.

phone_number: Option<String>

Optional. User’s verified phone number; available only for “phone_number” type

email: Option<String>

Optional. User’s verified email address; available only for “email” type

files: Option<Vec<PassportFile>>

Optional. Array of encrypted files with documents provided by the user; available only for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

front_side: Option<BoxWrapper<Unbox<PassportFile>>>

Optional. Encrypted file with the front side of the document, provided by the user; available only for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

reverse_side: Option<BoxWrapper<Unbox<PassportFile>>>

Optional. Encrypted file with the reverse side of the document, provided by the user; available only for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

selfie: Option<BoxWrapper<Unbox<PassportFile>>>

Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

translation: Option<Vec<PassportFile>>

Optional. Array of encrypted files with translated versions of documents provided by the user; available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

hash: String

Base64-encoded element hash for using in PassportElementErrorUnspecified

Implementations

impl EncryptedPassportElement

pub fn noskip(self) -> NoSkipEncryptedPassportElement

impl EncryptedPassportElement

pub fn new(hash: String) -> Self

pub fn get_tg_type<'a>(&'a self) -> &'a str

Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.

pub fn set_tg_type<'a>(&'a mut self, tg_type: String) -> &'a mut Self

Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.

pub fn get_data<'a>(&'a self) -> Option<&'a str>

Optional. Base64-encoded encrypted Telegram Passport element data provided by the user; available only for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials.

pub fn set_data<'a>(&'a mut self, data: Option<String>) -> &'a mut Self

Optional. Base64-encoded encrypted Telegram Passport element data provided by the user; available only for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials.

pub fn get_phone_number<'a>(&'a self) -> Option<&'a str>

Optional. User’s verified phone number; available only for “phone_number” type

pub fn set_phone_number<'a>( &'a mut self, phone_number: Option<String>, ) -> &'a mut Self

Optional. User’s verified phone number; available only for “phone_number” type

pub fn get_email<'a>(&'a self) -> Option<&'a str>

Optional. User’s verified email address; available only for “email” type

pub fn set_email<'a>(&'a mut self, email: Option<String>) -> &'a mut Self

Optional. User’s verified email address; available only for “email” type

pub fn get_files<'a>(&'a self) -> Option<&'a Vec<PassportFile>>

Optional. Array of encrypted files with documents provided by the user; available only for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

pub fn set_files<'a>( &'a mut self, files: Option<Vec<PassportFile>>, ) -> &'a mut Self

Optional. Array of encrypted files with documents provided by the user; available only for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

pub fn get_front_side<'a>(&'a self) -> Option<&'a PassportFile>

Optional. Encrypted file with the front side of the document, provided by the user; available only for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

pub fn set_front_side<'a>( &'a mut self, front_side: Option<PassportFile>, ) -> &'a mut Self

Optional. Encrypted file with the front side of the document, provided by the user; available only for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

pub fn get_reverse_side<'a>(&'a self) -> Option<&'a PassportFile>

Optional. Encrypted file with the reverse side of the document, provided by the user; available only for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

pub fn set_reverse_side<'a>( &'a mut self, reverse_side: Option<PassportFile>, ) -> &'a mut Self

Optional. Encrypted file with the reverse side of the document, provided by the user; available only for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

pub fn get_selfie<'a>(&'a self) -> Option<&'a PassportFile>

Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

pub fn set_selfie<'a>( &'a mut self, selfie: Option<PassportFile>, ) -> &'a mut Self

Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.

pub fn get_translation<'a>(&'a self) -> Option<&'a Vec<PassportFile>>

Optional. Array of encrypted files with translated versions of documents provided by the user; available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

pub fn set_translation<'a>( &'a mut self, translation: Option<Vec<PassportFile>>, ) -> &'a mut Self

Optional. Array of encrypted files with translated versions of documents provided by the user; available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

pub fn get_hash<'a>(&'a self) -> &'a str

Base64-encoded element hash for using in PassportElementErrorUnspecified

pub fn set_hash<'a>(&'a mut self, hash: String) -> &'a mut Self

Base64-encoded element hash for using in PassportElementErrorUnspecified

Trait Implementations

impl Clone for EncryptedPassportElement

fn clone(&self) -> EncryptedPassportElement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncryptedPassportElement

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

Formats the value using the given formatter.

impl Default for EncryptedPassportElement

fn default() -> EncryptedPassportElement

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EncryptedPassportElement

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BoxWrapper<Box<EncryptedPassportElement>>> for EncryptedPassportElement

fn from(t: BoxWrapper<Box<EncryptedPassportElement>>) -> Self

Converts to this type from the input type.

impl From<BoxWrapper<Unbox<EncryptedPassportElement>>> for EncryptedPassportElement

fn from(t: BoxWrapper<Unbox<EncryptedPassportElement>>) -> Self

Converts to this type from the input type.

impl From<NoSkipEncryptedPassportElement> for EncryptedPassportElement

fn from(t: NoSkipEncryptedPassportElement) -> Self

Converts to this type from the input type.

impl Hash for EncryptedPassportElement

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 Into<NoSkipEncryptedPassportElement> for EncryptedPassportElement

fn into(self) -> NoSkipEncryptedPassportElement

Converts this type into the (usually inferred) input type.

impl Ord for EncryptedPassportElement

fn cmp(&self, other: &EncryptedPassportElement) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for EncryptedPassportElement

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

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

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 EncryptedPassportElement

impl StructuralPartialEq for EncryptedPassportElement