Struct telegram_bot::Api

pub struct Api(_);

Main type for sending requests to the Telegram bot API.

Implementations

impl Api

pub fn new<T: AsRef<str>>(token: T) -> Self

Create a new Api instance.

Example

Using default connector.

use telegram_bot::Api;

let api = Api::new(telegram_token);

pub fn with_connector<T: AsRef<str>>(
    token: T,
    connector: Box<dyn Connector>
) -> Self

Create a new Api instance wtih custom connector.

pub fn stream(&self) -> UpdatesStream

Create a stream which produces updates from the Telegram server.

Examples

use futures::StreamExt;


let mut stream = api.stream();
let update = stream.next().await;
    println!("{:?}", update);

pub fn spawn<Req: Request>(&self, request: Req)

Send a request to the Telegram server and do not wait for a response.

Examples

let chat = ChatId::new(61031);
api.spawn(chat.text("Message"));

pub fn send_timeout<Req: Request>(
    &self,
    request: Req,
    duration: Duration
) -> impl Future<Output = Result<Option<<Req::Response as ResponseType>::Type>, Error>> + Send

Send a request to the Telegram server and wait for a response, timing out after duration. Future will resolve to None if timeout fired.

Examples

let result = api.send_timeout(GetMe, Duration::from_secs(2)).await;
println!("{:?}", result);

pub fn send<Req: Request>(
    &self,
    request: Req
) -> impl Future<Output = Result<<Req::Response as ResponseType>::Type, Error>> + Send

Send a request to the Telegram server and wait for a response.

Examples

let result = api.send(GetMe).await;
println!("{:?}", result);

Trait Implementations

impl Clone for Api

fn clone(&self) -> Api

Returns a copy of the value.

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

Performs copy-assignment from source.