Struct MatrixBot 

pub struct MatrixBot { /* private fields */ }

Matrix bot builder

Create a bot with command and reaction handlers, then call run() to start.

Example

use botkit_matrix::{MatrixBot, MatrixConfig};
use botkit_core::{Bot, User};

async fn ping() -> &'static str { "Pong!" }
async fn greet(user: User) -> String { format!("Hello, {}!", user.name) }

let config = MatrixConfig::new("https://matrix.org")
    .password_auth("@bot:matrix.org", "password")
    .command_prefix("!");

MatrixBot::new(config)
    .command("ping", ping)
    .command("greet", greet)
    .run()
    .await
    .unwrap();

Implementations

impl MatrixBot

pub fn new(config: MatrixConfig) -> Self

Create a new Matrix bot with the given configuration

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

where H: IntoHandler<Args>,

Register a command handler (e.g., !ping, !help)

Commands are parsed from message text using the configured prefix.

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 description

pub fn reaction<H, Args>(self, emoji: impl AsRef<str>, handler: H) -> Self

where H: IntoHandler<Args>,

Register a reaction handler

Reactions are routed through the same table as buttons, under the id reaction:<emoji>, so a single handler can serve a Discord button and a Matrix reaction.

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

where H: IntoHandler<Args>,

Register a message handler (for non-command messages)

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

where H: IntoHandler<Args>,

Register a handler for events nothing else claimed

Unregistered commands and unmatched reactions reach the fallback rather than being dropped. See BotBuilder::fallback.

Trait Implementations

impl Bot for MatrixBot

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

Run the bot until shutdown fires or a fatal error occurs

fn run(self) -> impl BotFutureBounds

Run the bot until a fatal error occurs