Struct Client 

pub struct Client { /* private fields */ }

The main Telegram client. Cheap to clone — internally Arc-wrapped.

Implementations

impl Client

pub async fn connect(config: Config) -> Result<Self, InvocationError>

Connect to Telegram and return a ready-to-use client.

Loads an existing session if the file exists, otherwise performs a full DH key exchange on DC2.

pub async fn save_session(&self) -> Result<(), InvocationError>

Save the current session to disk.

pub async fn is_authorized(&self) -> Result<bool, InvocationError>

Returns true if the client is already authorized.

pub async fn bot_sign_in(&self, token: &str) -> Result<String, InvocationError>

Sign in as a bot using a bot token from @BotFather.

Example

client.bot_sign_in("1234567890:ABCdef...").await?;

pub async fn request_login_code( &self, phone: &str, ) -> Result<LoginToken, InvocationError>

Request a login code for a user account.

Returns a LoginToken to pass to sign_in.

pub async fn sign_in( &self, token: &LoginToken, code: &str, ) -> Result<String, SignInError>

Complete sign-in with the code sent to the phone.

On 2FA accounts, returns Err(SignInError::PasswordRequired(token)). Pass the token to check_password.

pub async fn check_password( &self, token: PasswordToken, password: impl AsRef<[u8]>, ) -> Result<String, InvocationError>

Complete 2FA login.

token comes from Err(SignInError::PasswordRequired(token)).

pub async fn sign_out(&self) -> Result<bool, InvocationError>

Sign out and invalidate the current session.

pub fn stream_updates(&self) -> UpdateStream

Return an UpdateStream that yields incoming Updates.

The stream must be polled regularly (e.g. in a while let loop) for the client to stay connected and receive updates. Multiple streams can be created but only one should be polled at a time.

pub async fn send_message( &self, peer: &str, text: &str, ) -> Result<(), InvocationError>

Send a text message. Use "me" for Saved Messages.

pub async fn send_message_to_peer( &self, peer: Peer, text: &str, ) -> Result<(), InvocationError>

Send a text message to an already-resolved layer_tl_types::enums::InputPeer.

pub async fn send_to_self(&self, text: &str) -> Result<(), InvocationError>

Send a text message directly to “me” (Saved Messages).

pub async fn delete_messages( &self, message_ids: Vec<i32>, revoke: bool, ) -> Result<(), InvocationError>

Delete messages by ID in a given peer.

pub async fn answer_callback_query( &self, query_id: i64, text: Option<&str>, alert: bool, ) -> Result<bool, InvocationError>

Answer a callback query (from an inline button press).

Pass the query_id from update::CallbackQuery::query_id.

pub async fn answer_inline_query( &self, query_id: i64, results: Vec<InputBotInlineResult>, cache_time: i32, is_personal: bool, next_offset: Option<String>, ) -> Result<bool, InvocationError>

Answer an inline query.

results should be a list of tl::enums::InputBotInlineResult.

pub async fn get_dialogs( &self, limit: i32, ) -> Result<Vec<Dialog>, InvocationError>

Fetch up to limit dialogs (conversations), most recent first.

Returns a Vec<Dialog>. For paginated access, call repeatedly with offset parameters derived from the last result.

pub async fn get_messages( &self, peer: InputPeer, limit: i32, offset_id: i32, ) -> Result<Vec<IncomingMessage>, InvocationError>

Fetch messages from a peer’s history.

pub async fn resolve_peer(&self, peer: &str) -> Result<Peer, InvocationError>

Resolve a peer string ("me", "@username", phone, or numeric ID) to an InputPeer.

pub async fn invoke<R: RemoteCall>( &self, req: &R, ) -> Result<R::Return, InvocationError>

Invoke any TL function directly.

Handles flood-wait and I/O retries according to the configured RetryPolicy.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.