Struct BatchReadyEvent 

pub struct BatchReadyEvent {
    pub msg_ids: Vec<i64>,
    pub queue_name: String,
    pub namespace: String,
    pub message_count: i64,
    pub ready_at: DateTime<Utc>,
    pub metadata: HashMap<String, String>,
    pub delay_seconds: i32,
}

Event emitted when a batch of messages is ready for processing

This event is triggered when multiple messages are enqueued in PGMQ via batch operations and become available for processing. It provides the message IDs and queue information needed to claim and process the batch.

Examples

use tasker_pgmq::BatchReadyEvent;
use chrono::Utc;
use std::collections::HashMap;

let event = BatchReadyEvent {
    msg_ids: vec![1, 2, 3],
    queue_name: "tasks_queue".to_string(),
    namespace: "tasks".to_string(),
    message_count: 3,
    ready_at: Utc::now(),
    metadata: HashMap::new(),
    delay_seconds: 0,
};

assert_eq!(event.msg_ids, vec![1, 2, 3]);
assert_eq!(event.message_count, 3);

Fields

msg_ids: Vec<i64>

IDs of the messages in the batch

queue_name: String

Queue where the messages are available

namespace: String

Extracted namespace from the queue name

message_count: i64

Number of messages in the batch

ready_at: DateTime<Utc>

When the batch became ready

metadata: HashMap<String, String>

Optional message metadata (limited by payload size)

delay_seconds: i32

Delay in seconds before messages become visible

Implementations

impl BatchReadyEvent

pub fn new<S: Into<String>>( msg_ids: Vec<i64>, queue_name: S, namespace: S, ) -> Self

Create a new batch ready event

pub fn with_timestamp<S: Into<String>>( msg_ids: Vec<i64>, queue_name: S, namespace: S, ready_at: DateTime<Utc>, ) -> Self

Create with custom timestamp

pub fn with_metadata(self, metadata: HashMap<String, String>) -> Self

Add metadata to the event

pub fn add_metadata<K: Into<String>, V: Into<String>>( self, key: K, value: V, ) -> Self

Add a single metadata entry

pub fn with_delay_seconds(self, delay_seconds: i32) -> Self

Set delay seconds

Trait Implementations

impl Clone for BatchReadyEvent

fn clone(&self) -> BatchReadyEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchReadyEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BatchReadyEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BatchReadyEvent

fn eq(&self, other: &BatchReadyEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BatchReadyEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BatchReadyEvent