[][src]Struct telegram_bot::Api

pub struct Api(_);

Main type for sending requests to the Telegram bot API.

Implementations

impl Api[src]

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

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
[src]

Create a new Api instance wtih custom connector.

pub fn stream(&self) -> UpdatesStream[src]

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)[src]

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
[src]

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
[src]

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[src]

Auto Trait Implementations

impl !RefUnwindSafe for Api[src]

impl Send for Api[src]

impl Sync for Api[src]

impl Unpin for Api[src]

impl !UnwindSafe for Api[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 
[src]

impl<T> WithSubscriber for T[src]