Skip to main content

CallbackQueryHandler

Struct CallbackQueryHandler 

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

Handler for Update.callback_query.

When no pattern is set, any callback query matches. When a Data pattern is set, only queries with matching .data are accepted (queries with only .game_short_name are rejected, and vice versa).

Named capture groups in the regex pattern are exposed via context.named_matches (a HashMap<String, String>), while all captures (positional) are available as context.matches. This mirrors Python’s behaviour of putting the full re.Match object into context.matches.

§Example

use rust_tg_bot_ext::handlers::callback_query::{CallbackQueryHandler, CallbackPattern};
use rust_tg_bot_ext::handlers::base::*;
use regex::Regex;
use std::sync::Arc;

// Regex-based matching:
let handler = CallbackQueryHandler::new(
    Arc::new(|update, mr| Box::pin(async move { HandlerResult::Continue })),
    Some(CallbackPattern::Data(Regex::new(r"^btn_(\d+)$").unwrap())),
    true,
);

// Predicate-based matching (covers callable/type patterns):
let handler2 = CallbackQueryHandler::new(
    Arc::new(|update, mr| Box::pin(async move { HandlerResult::Continue })),
    Some(CallbackPattern::Predicate(Arc::new(|data| data.starts_with("action_")))),
    true,
);

Implementations§

Source§

impl CallbackQueryHandler

Source

pub fn new( callback: Arc<dyn Fn(Arc<Update>, MatchResult) -> Pin<Box<dyn Future<Output = HandlerResult> + Send>> + Sync + Send>, pattern: Option<CallbackPattern>, block: bool, ) -> CallbackQueryHandler

Create a new CallbackQueryHandler.

Trait Implementations§

Source§

impl Handler for CallbackQueryHandler

Source§

fn collect_additional_context( &self, context: &mut CallbackContext, match_result: &MatchResult, )

Populate context.matches (positional) and context.named_matches (named groups) from the regex match result.

Mirrors Python’s CallbackQueryHandler.collect_additional_context which injects the re.Match object into context.matches.

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

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