Skip to main content

MessageHandler

Struct MessageHandler 

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

Handler that matches updates based on the composable Filter trait system.

This is the most general-purpose handler. It mirrors the Python MessageHandler which delegates to a BaseFilter tree. The Rust port uses crate::filters::base::F – the operator-overloaded filter wrapper – so filters compose naturally with &, |, ^, !.

When a filter returns FilterResult::MatchWithData, the extracted data is stored in MatchResult::Custom and flows through to the handler callback.

§Ergonomic constructor

use rust_tg_bot_ext::prelude::*;

async fn echo(update: Update, context: Context) -> HandlerResult {
    let text = update.effective_message().and_then(|m| m.text.as_deref()).unwrap_or("");
    context.reply_text(&update, text).await?;
    Ok(())
}

MessageHandler::new(TEXT & !COMMAND, echo);

§Full-control constructor

use rust_tg_bot_ext::handlers::message::MessageHandler;
use rust_tg_bot_ext::handlers::base::*;
use rust_tg_bot_ext::filters::base::F;
use rust_tg_bot_ext::filters::base::All;
use std::sync::Arc;

let handler = MessageHandler::with_options(
    Some(F::new(All)),
    Arc::new(|update, _mr| Box::pin(async move { HandlerResult::Continue })),
    true,
);

Implementations§

Source§

impl MessageHandler

Source

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

Ergonomic constructor matching python-telegram-bot’s MessageHandler(filters, callback).

Accepts a composable filter and an async handler function with signature async fn(Update, Context) -> HandlerResult.

§Example
use rust_tg_bot_ext::prelude::*;

async fn echo(update: Update, context: Context) -> HandlerResult {
    let text = update.effective_message().and_then(|m| m.text.as_deref()).unwrap_or("");
    context.reply_text(&update, text).await?;
    Ok(())
}

MessageHandler::new(TEXT & !COMMAND, echo);
Source

pub fn with_options( filter: Option<F>, callback: Arc<dyn Fn(Arc<Update>, MatchResult) -> Pin<Box<dyn Future<Output = HandlerResult> + Send>> + Sync + Send>, block: bool, ) -> MessageHandler

Full-control constructor for advanced use cases.

If filter is None, every Update matches (equivalent to the Python filters.ALL).

Source

pub fn from_fn( filter: Option<Arc<dyn Fn(&Update) -> bool + Sync + Send>>, callback: Arc<dyn Fn(Arc<Update>, MatchResult) -> Pin<Box<dyn Future<Output = HandlerResult> + Send>> + Sync + Send>, block: bool, ) -> MessageHandler

Create a MessageHandler from a legacy closure filter.

This is a convenience constructor for backward compatibility with code that uses Fn(&Update) -> bool closures instead of the Filter trait.

Trait Implementations§

Source§

impl Handler for MessageHandler

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 block(&self) -> bool

Whether the application should block on this handler’s future before dispatching to the next handler group.
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 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