Skip to main content

ThreadHandle

Struct ThreadHandle 

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

A scoped handle to a conversation thread.

Holds a reference to the originating adapter, the thread identifier, and the shared subscription map so handlers can interact with the thread without needing access to the full ChatBot.

Implementations§

Source§

impl ThreadHandle

Source

pub fn thread_id(&self) -> &str

Return the thread identifier.

Source

pub fn adapter_name(&self) -> &str

Return the name of the adapter backing this handle.

Source

pub async fn post( &self, message: impl Into<PostableMessage>, ) -> Result<SentMessage, ChatError>

Post a message to this thread.

For PostableMessage::Text and PostableMessage::Markdown, the message is forwarded to the adapter via ChatAdapter::post_message.

§Errors

Returns an error if the adapter fails to post.

Source

pub async fn post_ephemeral( &self, user_id: &str, message: impl Into<AdapterPostableMessage>, fallback_to_dm: bool, ) -> Result<Option<EphemeralMessage>, ChatError>

Post an ephemeral message visible only to the specified user.

If the adapter does not support ephemeral messages and fallback_to_dm is true, falls back to opening a direct-message channel with the user and posting there.

§Errors

Returns an error if both the ephemeral post and DM fallback fail.

Source

pub async fn start_typing(&self, status: Option<&str>) -> Result<(), ChatError>

Show a typing / status indicator in this thread.

§Errors

Returns an error if the adapter fails.

Source

pub async fn subscribe(&self)

Subscribe to follow-up messages in this thread.

Subsequent ChatEvent::Message events for this thread will be routed to on_subscribed_message handlers instead of on_message.

Source

pub async fn unsubscribe(&self)

Unsubscribe from this thread.

Source

pub fn mention_user(&self, user_id: &str) -> String

Format a platform-agnostic mention string for a user.

This is a simple helper that returns <@user_id>. Adapters that need a different format should handle it at the rendering layer.

Trait Implementations§

Source§

impl Debug for ThreadHandle

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. 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, 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