Struct PgmqNotifyConfig 

pub struct PgmqNotifyConfig {
    pub queue_naming_pattern: String,
    pub channels_prefix: Option<String>,
    pub enable_triggers: bool,
    pub default_namespaces: HashSet<String>,
    pub max_payload_size: usize,
    pub include_metadata: bool,
}

Configuration for PGMQ notification behavior

This struct controls how PGMQ notifications are generated, formatted, and delivered. It allows customization of queue naming patterns, notification channels, and automatic listening behavior.

Examples

use tasker_pgmq::PgmqNotifyConfig;
use std::collections::HashSet;

// Basic configuration with defaults
let config = PgmqNotifyConfig::new();
assert_eq!(config.queue_naming_pattern, r"(?P<namespace>\w+)_queue");
assert!(!config.enable_triggers); // Triggers disabled by default

// Custom configuration with namespace listening
let mut namespaces = HashSet::new();
namespaces.insert("orders".to_string());
namespaces.insert("inventory".to_string());

let config = PgmqNotifyConfig {
    queue_naming_pattern: r"(?P<namespace>\w+)_messages".to_string(),
    channels_prefix: Some("prod".to_string()),
    enable_triggers: true,
    default_namespaces: namespaces,
    max_payload_size: 4000,
    include_metadata: false,
};

assert_eq!(config.channels_prefix, Some("prod".to_string()));
assert!(config.default_namespaces.contains("orders"));

Fields

queue_naming_pattern: String

Pattern for extracting namespace from queue names Should contain a named capture group “namespace” Default: r"(?P<namespace>\w+)_queue" matches “orders_queue” -> “orders”

channels_prefix: Option<String>

Optional prefix for all notification channels to avoid conflicts Example: “app1” results in channels like “app1.pgmq_queue_created”

enable_triggers: bool

Whether to enable database triggers for automatic notifications If false, relies on application-level emitters

default_namespaces: HashSet<String>

Default namespaces to auto-listen for message_ready events

max_payload_size: usize

Maximum payload size in bytes (pg_notify limit is 8000)

include_metadata: bool

Whether to include queue metadata in notifications

Implementations

impl PgmqNotifyConfig

pub fn new() -> Self

Create a new configuration with defaults

pub fn with_queue_naming_pattern<S: Into<String>>(self, pattern: S) -> Self

Set the queue naming pattern for namespace extraction

pub fn with_channels_prefix<S: Into<String>>(self, prefix: S) -> Self

Set the channels prefix to avoid conflicts

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

Enable or disable database triggers

pub fn with_default_namespace<S: Into<String>>(self, namespace: S) -> Self

Add a default namespace to auto-listen

pub fn with_default_namespaces<I, S>(self, namespaces: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add multiple default namespaces

pub fn with_max_payload_size(self, size: usize) -> Self

Set maximum payload size

pub fn with_metadata_included(self, include: bool) -> Self

Enable/disable metadata inclusion

pub fn validate(&self) -> Result<()>

Validate the configuration

pub fn compiled_pattern(&self) -> Result<Regex>

Compile the queue naming pattern regex

pub fn extract_namespace(&self, queue_name: &str) -> Result<String>

Extract namespace from queue name using the configured pattern

pub fn build_channel_name(&self, base_channel: &str) -> Result<String>

Build channel name with optional prefix, validating the result

pub fn build_namespace_channel( &self, base_channel: &str, namespace: &str, ) -> Result<String>

Build namespace-specific channel name, validating the result

pub fn queue_created_channel(&self) -> Result<String>

Get the queue created channel name

pub fn message_ready_channel(&self, namespace: &str) -> Result<String>

Get the message ready channel name for a namespace

pub fn global_message_ready_channel(&self) -> Result<String>

Get the global message ready channel name

Trait Implementations

impl Clone for PgmqNotifyConfig

fn clone(&self) -> PgmqNotifyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PgmqNotifyConfig

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

Formats the value using the given formatter.

impl Default for PgmqNotifyConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PgmqNotifyConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PgmqNotifyConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.