Struct telegram_bot_async::Api

pub struct Api<C: Connector> { /* fields omitted */ }

Main type for sending requests to the Telegram bot API.

Methods

impl<C: Connector> Api<C>

pub fn new_default(token: String) -> Result<DefaultApi, Error>

Start construction of the Api instance.

Examples

Using default connector.

use telegram_bot_fork::DefaultApi;

let api = DefaultApi::new_default(telegram_token.to_string()).unwrap();

pub fn with_connector(token: String, connector: C) -> Api<C>

Creates new API using custom connector.

use telegram_bot_fork::{connector::hyper, Api};

let api = Api::with_connector(telegram_token.to_string(), hyper::default_connector().unwrap());

pub fn set_url<T: AsRef<str>>(&mut self, url: T) -> &mut Self

Sets base telegram API server URL.

pub fn into_stream(self) -> UpdatesStream<C>

Create a stream which produces updates from the Telegram server.

Examples

#[for_await]
for update in stream.updates() {
    println!("{:?}", update);
}
Ok(())

pub async fn send_timeout<'_, Req: Request>(
    &'_ self,
    request: Req,
    duration: Duration
) -> Result<<Req::Response as ResponseType>::Type, Error>

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

use std::time::Duration;

let resp = api.send_timeout(GetMe, Duration::from_secs(5)).await?;
Ok(())

pub async fn send<'_, Req: Request>(
    &'_ self,
    request: Req
) -> Result<<Req::Response as ResponseType>::Type, Error>

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

Examples

let resp = api.send(GetMe).await?;
Ok(())

Trait Implementations

impl<C: Clone + Connector> Clone for Api<C>

fn clone(&self) -> Api<C>

Returns a copy of the value.

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

Performs copy-assignment from source.