Skip to main content

FnHandler

Struct FnHandler 

Source
pub struct FnHandler { /* private fields */ }
Expand description

A lightweight handler that pairs a predicate with an async callback.

FnHandler bridges the gap between raw application::Handler structs and the typed handler trait system. It implements Handler so it can be registered via [Application::add_handler].

§Examples

use rust_tg_bot::ext::prelude::*;
use rust_tg_bot::ext::handlers::base::FnHandler;

async fn button_handler(update: Update, context: Context) -> HandlerResult {
    // handle callback query ...
    Ok(())
}

// Register with a predicate:
app.add_handler(
    FnHandler::new(|u| u.callback_query().is_some(), button_handler),
    0,
).await;

// Or use a convenience constructor:
app.add_handler(FnHandler::on_callback_query(button_handler), 0).await;

Implementations§

Source§

impl FnHandler

Source

pub fn new<C, Cb, Fut>(check: C, callback: Cb) -> FnHandler
where C: Fn(&Update) -> bool + Send + Sync + 'static, Cb: Fn(Arc<Update>, CallbackContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), HandlerError>> + Send + 'static,

Create a new FnHandler with a custom predicate and an async callback.

The callback receives (Update, CallbackContext) and returns Result<(), HandlerError>.

Source

pub fn on_callback_query<Cb, Fut>(callback: Cb) -> FnHandler
where Cb: Fn(Arc<Update>, CallbackContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), HandlerError>> + Send + 'static,

Match updates that have a callback_query.

Source

pub fn on_inline_query<Cb, Fut>(callback: Cb) -> FnHandler
where Cb: Fn(Arc<Update>, CallbackContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), HandlerError>> + Send + 'static,

Match updates that have an inline_query.

Source

pub fn on_poll<Cb, Fut>(callback: Cb) -> FnHandler
where Cb: Fn(Arc<Update>, CallbackContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), HandlerError>> + Send + 'static,

Match updates that have a poll.

Source

pub fn on_poll_answer<Cb, Fut>(callback: Cb) -> FnHandler
where Cb: Fn(Arc<Update>, CallbackContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), HandlerError>> + Send + 'static,

Match updates that have a poll_answer.

Source

pub fn on_shipping_query<Cb, Fut>(callback: Cb) -> FnHandler
where Cb: Fn(Arc<Update>, CallbackContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), HandlerError>> + Send + 'static,

Match updates that have a shipping_query.

Source

pub fn on_pre_checkout_query<Cb, Fut>(callback: Cb) -> FnHandler
where Cb: Fn(Arc<Update>, CallbackContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), HandlerError>> + Send + 'static,

Match updates that have a pre_checkout_query.

Source

pub fn on_chat_member<Cb, Fut>(callback: Cb) -> FnHandler
where Cb: Fn(Arc<Update>, CallbackContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), HandlerError>> + Send + 'static,

Match updates that have a chat_member.

Source

pub fn on_my_chat_member<Cb, Fut>(callback: Cb) -> FnHandler
where Cb: Fn(Arc<Update>, CallbackContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), HandlerError>> + Send + 'static,

Match updates that have a my_chat_member.

Source

pub fn on_message<Cb, Fut>(callback: Cb) -> FnHandler
where Cb: Fn(Arc<Update>, CallbackContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), HandlerError>> + Send + 'static,

Match updates that have a message.

Source

pub fn on_any<Cb, Fut>(callback: Cb) -> FnHandler
where Cb: Fn(Arc<Update>, CallbackContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), HandlerError>> + Send + 'static,

Match every update (catch-all).

Trait Implementations§

Source§

impl Handler for FnHandler

Source§

fn check_update(&self, update: &Update) -> Option<MatchResult>

Determine whether this handler is interested in update. Read more
Source§

fn handle_update( &self, _update: Arc<Update>, _match_result: MatchResult, ) -> Pin<Box<dyn Future<Output = HandlerResult> + Send>>

Process the update. Called only when check_update returned Some.
Source§

fn handle_update_with_context( &self, update: Arc<Update>, _match_result: MatchResult, context: CallbackContext, ) -> Pin<Box<dyn Future<Output = HandlerResult> + Send>>

Process the update with an Application-provided CallbackContext. Read more
Source§

fn block(&self) -> bool

Whether the application should block on this handler’s future before dispatching to the next handler group.
Source§

fn collect_additional_context( &self, _context: &mut CallbackContext, _match_result: &MatchResult, )

Populate additional context fields (e.g. context.args, context.matches) from the match result before the handler callback is invoked. Read more

Auto Trait Implementations§

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> 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, 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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<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