Skip to main content

Context

Struct Context 

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

Context for handling bot events

Provides access to event data and platform client. Platform-specific details are abstracted away - handlers work with a unified API.

Implementations§

Source§

impl Context

Source

pub fn new<T: ContextData>(data: T) -> Self

Create a new context (called by platform implementations)

Source

pub fn channel_id(&self) -> &str

Get the channel/chat ID

Source

pub fn user_id(&self) -> &str

Get the user ID who triggered the event

Source

pub fn user_name(&self) -> &str

Get the user’s display name

Source

pub fn command_name(&self) -> Option<&str>

Get the command name if this is a command event

Source

pub fn command_args(&self) -> Option<&str>

Get command arguments as a string (for Telegram-style commands)

Source

pub fn option(&self, name: &str) -> Option<OptionValue>

Get a command option value by name

Source

pub fn button_id(&self) -> Option<&str>

Get the button/callback custom_id if this is a button event

Source

pub fn message_content(&self) -> Option<&str>

Get the message content if available

Source

pub fn platform<T: 'static>(&self) -> Option<&T>

Access platform-specific raw data (for advanced use cases)

Returns Some(&T) if the underlying platform data is of type T.

Source

pub fn data(&self) -> &dyn ContextData

Get the inner context data for platform implementations

Source

pub fn typing(&self) -> Option<ChatActionGuard>

Start a typing indicator that auto-renews until the guard is dropped

Returns None if the platform doesn’t support typing indicators or if the context doesn’t have the necessary client.

§Example
async fn slow_command(ctx: Context) -> String {
    let _typing = ctx.typing();
    // Do slow work...
    expensive_computation().await;
    "Done!"
}

Trait Implementations§

Source§

impl Clone for Context

Source§

fn clone(&self) -> Context

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

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

Performs copy-assignment from source. Read more
Source§

impl FromContext for Context

Extract the full context (for advanced use cases)

Source§

async fn from_context(ctx: &Context) -> Self

Extract data from the context

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> 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, 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<T> ChatActionSenderBounds for T
where T: Send + Sync + ?Sized,