Struct Api

Source
pub struct Api(/* private fields */);
Expand description

Main type for sending requests to the Telegram bot API.

Implementations§

Source§

impl Api

Source

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

Create a new Api instance.

§Example

Using default connector.

use telegram_bot_ars::Api;

let api = Api::new(telegram_token);
Source

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

Create a new Api instance wtih custom connector.

Source

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);
Source

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"));
Source

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);
Source

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§

Source§

impl Clone for Api

Source§

fn clone(&self) -> Api

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl Freeze for Api

§

impl !RefUnwindSafe for Api

§

impl Send for Api

§

impl Sync for Api

§

impl Unpin for Api

§

impl !UnwindSafe for Api

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more