Struct MatrixConfig 

pub struct MatrixConfig {

    pub enabled: bool,
    pub homeserver: String,
    pub access_token: Option<String>,
    pub user_id: Option<String>,
    pub device_id: Option<String>,
    pub allowed_rooms: Vec<String>,
    pub interrupt_on_new_message: bool,
    pub stream_mode: StreamMode,
    pub draft_update_interval_ms: u64,
    pub multi_message_delay_ms: u64,
    pub mention_only: bool,
    pub recovery_key: Option<String>,
    pub password: Option<String>,
    pub approval_timeout_secs: u64,
    pub reply_in_thread: bool,
    pub ack_reactions: Option<bool>,
    pub excluded_tools: Vec<String>,
    pub default_target: Option<String>,
}

Matrix channel configuration.

Fields

enabled: bool

Whether this channel is active. The runtime only loads channels whose enabled = true. Default: false so an operator who pastes a partial [channels.<type>.<alias>] block doesn’t accidentally bring a channel live before the rest of its config is filled in.

homeserver: String

Matrix homeserver URL (e.g. "https://matrix.org").

access_token: Option<String>

Matrix access token for the bot account. When unset, the channel falls back to password login using user_id + password.

user_id: Option<String>

Optional Matrix user ID (e.g. "@bot:matrix.org").

device_id: Option<String>

Optional Matrix device ID.

allowed_rooms: Vec<String>

Allowed Matrix room IDs or aliases. Empty = allow all rooms. Supports canonical room IDs (!abc:server) and aliases (#room:server).

interrupt_on_new_message: bool

Whether to interrupt an in-flight agent response when a new message arrives.

stream_mode: StreamMode

Streaming mode for progressive response delivery. "off" (default): single message. "partial": edit-in-place draft. "multi_message": paragraph-split delivery.

draft_update_interval_ms: u64

Minimum interval (ms) between draft message edits in Partial mode.

multi_message_delay_ms: u64

Delay (ms) between sending each paragraph in MultiMessage mode.

mention_only: bool

When true, only respond to messages that @-mention the bot in groups. Direct messages are always processed.

recovery_key: Option<String>

Optional Matrix recovery key for automatic E2EE key backup restore. When set, ZeroClaw recovers room keys and cross-signing secrets on startup.

password: Option<String>

Optional login password for Matrix account (used for initial login flow).

approval_timeout_secs: u64

Seconds to wait for operator approval on always_ask tools before auto-denying.

reply_in_thread: bool

When true (default), replies are sent as thread replies. Starts a new thread from the incoming message when none exists. When false, only continues existing threads.

ack_reactions: Option<bool>

Override for the top-level [channels].ack_reactions. When None, falls back to the channels-wide default. When set explicitly (true/false), takes precedence for this Matrix instance only.

excluded_tools: Vec<String>

Tools excluded from this channel’s tool spec. When set, these tools are not exposed to the model when responding via this channel.

default_target: Option<String>

Default recipient for daemon/CLI channel_send calls. Injected into the agent system prompt so it knows where to deliver outbound messages without asking the user for a target ID.

Implementations

impl MatrixConfig

pub fn configurable_prefix() -> &'static str

Returns the #[prefix] value for this Configurable struct.

pub fn secret_fields(&self) -> Vec<SecretFieldInfo>

Returns metadata about all #[secret] fields on this struct and nested children.

pub fn secret_field_terminals() -> Vec<&'static str>

Static enumeration of every #[secret] field’s terminal name (snake_case, matching the on-disk TOML key) reachable from this type via #[nested] traversal. Unlike secret_fields(), this requires no instance — the per-struct codegen literals are joined at call time with recursive calls into the inner types’ own secret_field_terminals().

Used by the migration crate’s raw-TOML encrypt walker as the secret-key allowlist. prop_fields()-derived allowlists skip compound (non-Vec) #[secret] fields, so this method is the authoritative source.

pub fn encrypt_secrets(&mut self, store: &SecretStore) -> Result<(), Error>

Encrypt all secret fields in place using the provided store.

pub fn decrypt_secrets(&mut self, store: &SecretStore) -> Result<(), Error>

Decrypt all secret fields in place using the provided store.

pub fn set_secret(&mut self, name: &str, value: String) -> Result<(), Error>

Set a secret field by its full dotted name, dispatching to nested children.

pub fn prop_fields(&self) -> Vec<PropFieldInfo>

Returns metadata about all property fields on this struct and nested children.

pub fn get_prop(&self, name: &str) -> Result<String, Error>

Get a property value by its full dotted name, returning it as a display string.

pub fn set_prop(&mut self, name: &str, value_str: &str) -> Result<(), Error>

Set a property value by its full dotted name, parsing from string.

pub fn prop_is_secret(name: &str) -> bool

Check if a property name refers to a secret field (static, no instance needed).

pub fn init_defaults(&mut self, prefix: Option<&str>) -> Vec<&'static str>

Instantiate None nested sections whose prefix matches. Returns the prefixes that were initialized.

pub fn map_key_sections() -> Vec<MapKeySection>

Enumerate every map-keyed (HashMap<String, T>) and list-shaped (Vec<T>) section discoverable from this Configurable’s tree. The dashboard / CLI consume this to surface “+ Add” affordances without hardcoding the section list.

pub fn nested_section_help(name: &str) -> Option<&'static str>

Help blurb for a #[nested] field on this struct, sourced from the field-level /// docstring. Returns None for unknown names so callers can fall through to a different lookup.

pub fn get_map_keys(&self, section_path: &str) -> Option<Vec<String>>

Return the current alias keys at section_path, or None if the path doesn’t resolve to a map-keyed section in this tree.

pub fn nested_option_entries(&self) -> Vec<NestedOptionEntry>

Snapshot of every #[nested] Option<T> field on this struct as (field_name, is_some) tuples, in declaration order.

field_name is the raw Rust ident (snake_case) — consumers can map to display names via their own table. The schema is the single source of truth: adding a new pub foo: Option<FooConfig> field with #[nested] surfaces here without touching any caller.

pub fn create_map_key( &mut self, section_path: &str, map_key: &str, ) -> Result<bool, String>

Insert a default-valued entry under a map-keyed section, or append to a list-shaped one, with map_key as the new entry’s natural identifier (HashMap key for Map sections; identifier field for List sections).

Returns Ok(true) if a new entry was created, Ok(false) if the entry already existed (idempotent), or Err(reason) if the section path doesn’t resolve to a Map/List in this tree.

pub fn delete_map_key( &mut self, section_path: &str, map_key: &str, ) -> Result<bool, String>

Remove the entry identified by map_key from the map-keyed section at section_path.

Returns Ok(true) if the entry existed and was removed, Ok(false) if it didn’t exist, or Err(reason) if the section path doesn’t resolve.

pub fn rename_map_key( &mut self, section_path: &str, map_key: &str, new_key: &str, ) -> Result<bool, String>

Rename map_key to new_key within the map-keyed section at section_path, preserving the entry’s value.

Returns Ok(true) if renamed, Ok(false) if map_key didn’t exist, or Err(reason) if new_key already exists or the section path doesn’t resolve.

Trait Implementations

impl ChannelConfig for MatrixConfig

fn name() -> &'static str

human-readable name

fn desc() -> &'static str

short description

impl Clone for MatrixConfig

fn clone(&self) -> MatrixConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MatrixConfig

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

Formats the value using the given formatter.

impl Default for MatrixConfig

fn default() -> MatrixConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MatrixConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<MatrixConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for MatrixConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl MaskSecrets for MatrixConfig

fn mask_secrets(&mut self)

fn restore_secrets_from(&mut self, current: &MatrixConfig)

impl Serialize for MatrixConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.