Struct SignalConfig 

pub struct SignalConfig {
    pub enabled: bool,
    pub http_url: String,
    pub account: String,
    pub group_ids: Vec<String>,
    pub dm_only: bool,
    pub ignore_attachments: bool,
    pub ignore_stories: bool,
    pub proxy_url: Option<String>,
    pub approval_timeout_secs: u64,
    pub excluded_tools: Vec<String>,
    pub reply_min_interval_secs: u64,
    pub reply_queue_depth_max: u16,
}

Signal channel configuration.

Default is implemented below rather than derived. A derived Default zeroes every field, which disagrees with the serde defaults, and for approval_timeout_secs that disagreement is load-bearing: 0 is an already-elapsed deadline, so an alias built in Rust would deny every approval while an alias parsed from a file waits the documented 300s.

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.

http_url: String

Base URL for the signal-cli HTTP daemon (e.g. "http://127.0.0.1:8686").

account: String

E.164 phone number of the signal-cli account (e.g. “+1234567890”).

group_ids: Vec<String>

Group IDs to filter messages. Empty = accept all messages (DMs and groups). When non-empty, only messages from listed groups are accepted (DMs are still accepted unless dm_only flips the policy to DMs-only). Migrated from the legacy group_id singular field.

dm_only: bool

When true, only accept direct messages and ignore all group traffic. Mutually exclusive with group_ids (which is ignored when this is set). Migrated from the legacy group_id = "dm" sentinel.

ignore_attachments: bool

Skip messages that are attachment-only (no text body).

ignore_stories: bool

Skip incoming story messages.

proxy_url: Option<String>

Per-channel proxy URL (http, https, socks5, socks5h). Overrides the global [proxy] setting for this channel only.

approval_timeout_secs: u64

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

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.

reply_min_interval_secs: u64

Per-(channel, recipient) outbound pacing floor in seconds. Range: 0..=REPLY_MIN_INTERVAL_MAX_SECS (0 disables).

reply_queue_depth_max: u16

Per-(channel, recipient) outbound pacing queue depth. Range: 0..=REPLY_QUEUE_DEPTH_CEILING. When reply_min_interval_secs > 0 and this value is 0, the pacing wrapper substitutes DEFAULT_REPLY_QUEUE_DEPTH (16). When the queue is full, the newest send is dropped and a WARN is logged.

Implementations

impl SignalConfig

pub fn configurable_prefix() -> &'static str

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

pub fn init_requires_explicit_config() -> bool

True when this struct has a required leaf field that a bare/ancestor-prefix init_defaults scaffold must not materialize (it would fill the field with its Rust Default, which prune_empty_leaves then strips on save, leaving a partial sub-table that fails strict reload). Explicitly targeting this section (or a descendant of it) still scaffolds regardless of this flag, so the section can be materialized for the operator to fill in.

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>

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 nested_section_group(name: &str) -> Option<&'static str>

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>

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

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

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

impl SignalConfig

pub fn has_required_credentials(&self) -> bool

Whether both required credentials (http_url, account) are present. Mirrors WhatsAppConfig::is_cloud_config’s role: the channel orchestrator uses this bool to decide whether to build the channel at all, skipping (with a warning) an enabled-but-uncredentialed alias instead of building a listener that can never connect and crashloops its per-channel supervisor.

pub fn validate_required(&self, alias: &str) -> Result<(), Error>

Validate this alias’s required credentials once enabled. Mirrors TelegramConfig::validate_bot_token / DiscordConfig::validate_bot_token: an enabled Signal channel built with an empty http_url or account never connects and crashloops its per-channel supervisor, so reject it at config-load time instead.

Trait Implementations

impl ChannelConfig for SignalConfig

fn name() -> &'static str

human-readable name

fn desc() -> &'static str

short description

impl Clone for SignalConfig

fn clone(&self) -> SignalConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignalConfig

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

Formats the value using the given formatter.

impl Default for SignalConfig

fn default() -> SignalConfig

Built by deserializing an object supplying only http_url and account, the two fields with no serde default - a Signal channel must always name its daemon and account, so they stay required rather than gaining one. Every other field either declares a serde default or is an Option, so this is the minimal object that makes the deserialize total; those defaults stay the only source of truth for everything but http_url and account.

impl<'de> Deserialize<'de> for SignalConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HasReplyPacing for SignalConfig

fn reply_min_interval_secs(&self) -> u64

fn reply_queue_depth_max(&self) -> u16

impl JsonSchema for SignalConfig

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 SignalConfig

fn mask_secrets(&mut self)

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

impl Serialize for SignalConfig

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.