Struct MatrixConfig 

pub struct MatrixConfig { /* private fields */ }

Matrix bot configuration

Configure the homeserver, authentication, command prefix, and other options.

Example

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

Implementations

impl MatrixConfig

pub fn new(homeserver_url: impl Into<String>) -> Self

Create a new Matrix configuration with the given homeserver URL

Authentication must be configured before building the bot.

pub fn password_auth( self, user_id: impl Into<String>, password: impl Into<String>, ) -> Self

Set password authentication

Arguments

• user_id - Matrix user ID (e.g., “@bot:matrix.org”)
• password - Password for the account

pub fn access_token_auth( self, user_id: OwnedUserId, access_token: impl Into<String>, device_id: OwnedDeviceId, ) -> Self

Set access token authentication

Use this for pre-authenticated sessions. Requires the device ID for E2EE.

pub fn command_prefix(self, prefix: impl Into<String>) -> Self

Set the command prefix (default: “!”)

Messages starting with this prefix will be parsed as commands.

pub fn device_name(self, name: impl Into<String>) -> Self

Set the device display name

This appears in the user’s device list.

pub fn state_store_path(self, path: impl Into<PathBuf>) -> Self

Set the state store path for persistence

Enables session persistence and E2EE key storage. Without this, E2EE keys are lost on restart.

pub fn auto_join_rooms(self, enabled: bool) -> Self

Enable or disable auto-joining rooms when invited