Skip to main content

CliBot

Struct CliBot 

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

A bot whose “platform” is the CLI wire protocol.

Build it like any other adapter, take the CliHub handle if you need to drive it out-of-band (acpbot-style platform senders, tests), then run().

Implementations§

Source§

impl CliBot

Source

pub fn new(transport: Transport) -> Self

A bot on the given transport.

Source

pub fn hub(&self) -> CliHub

The shared hub handle: inject events, subscribe to outbound lines, or build platform senders on it.

Source

pub fn command<H, Args>(self, name: impl Into<String>, handler: H) -> Self
where H: IntoHandler<Args>,

Register a command handler.

Source

pub fn command_with_description<H, Args>( self, name: impl Into<String>, description: impl Into<String>, handler: H, ) -> Self
where H: IntoHandler<Args>,

Register a command handler with a menu description.

Source

pub fn button<H, Args>(self, pattern: impl Into<String>, handler: H) -> Self
where H: IntoHandler<Args>,

Register a button handler (* suffix matches by prefix).

Source

pub fn message<H, Args>(self, handler: H) -> Self
where H: IntoHandler<Args>,

Register the catch-all message handler.

Source

pub fn fallback<H, Args>(self, handler: H) -> Self
where H: IntoHandler<Args>,

Register the handler for events no route claims.

Trait Implementations§

Source§

impl Bot for CliBot

Source§

async fn run_until(self, shutdown: Shutdown) -> Result<(), BotError>

Run the bot until shutdown fires or a fatal error occurs Read more
Source§

fn run(self) -> impl BotFutureBounds

Run the bot until a fatal error occurs Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for CliBot

§

impl !Unpin for CliBot

§

impl !UnsafeUnpin for CliBot

§

impl !UnwindSafe for CliBot

§

impl Freeze for CliBot

§

impl Send for CliBot

§

impl Sync for CliBot

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

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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