Skip to main content

PgmqNotifyEvent

Enum PgmqNotifyEvent 

Source
pub enum PgmqNotifyEvent {
    QueueCreated(QueueCreatedEvent),
    MessageReady(MessageReadyEvent),
    MessageWithPayload(MessageWithPayloadEvent),
    BatchReady(BatchReadyEvent),
}
Expand description

Union of all possible PGMQ notification events

This enum represents all event types that can be emitted by PGMQ operations. Events are tagged for JSON serialization and can be pattern-matched for handling.

§Examples

use tasker_pgmq::{PgmqNotifyEvent, QueueCreatedEvent};
use chrono::Utc;

let event = PgmqNotifyEvent::QueueCreated(QueueCreatedEvent {
    queue_name: "new_queue".to_string(),
    namespace: "default".to_string(),
    created_at: Utc::now(),
    metadata: Default::default(),
});

match event {
    PgmqNotifyEvent::QueueCreated(e) => {
        println!("Queue created: {}", e.queue_name);
    }
    PgmqNotifyEvent::MessageReady(e) => {
        println!("Message ready: {}", e.msg_id);
    }
    PgmqNotifyEvent::MessageWithPayload(e) => {
        println!("Message with payload: {}", e.msg_id);
    }
    PgmqNotifyEvent::BatchReady(e) => {
        println!("Batch ready: {} messages", e.message_count);
    }
}

Variants§

§

QueueCreated(QueueCreatedEvent)

Queue was created

§

MessageReady(MessageReadyEvent)

Message is ready for processing in a queue (signal only, requires fetch) Used for large messages (>= 7KB) that don’t fit in pg_notify payload

§

MessageWithPayload(MessageWithPayloadEvent)

Message with full payload included (TAS-133) Used for small messages (< 7KB) - enables direct processing without fetch

§

BatchReady(BatchReadyEvent)

Batch of messages are ready for processing in a queue

Implementations§

Source§

impl PgmqNotifyEvent

Source

pub fn namespace(&self) -> &str

Get the namespace for any event type

Source

pub fn queue_name(&self) -> &str

Get the queue name for any event type

Source

pub fn timestamp(&self) -> DateTime<Utc>

Get the timestamp for any event type

Source

pub fn metadata(&self) -> &HashMap<String, String>

Get metadata for any event type

Note: MessageWithPayload events don’t have metadata, returns empty HashMap

Source

pub fn matches_namespace(&self, namespace: &str) -> bool

Check if event matches a specific namespace

Source

pub fn event_type(&self) -> &'static str

Get the event type as a string

Source

pub fn msg_id(&self) -> Option<i64>

Get the message ID if this event is message-related

Returns Some(msg_id) for MessageReady and MessageWithPayload events, None for queue creation and batch events.

Source

pub fn has_payload(&self) -> bool

Check if this event includes the full message payload (TAS-133)

Returns true for MessageWithPayload events where the message can be processed directly without a separate fetch.

Source

pub fn payload(&self) -> Option<&Value>

Get the message payload if available (TAS-133)

Returns Some(&Value) for MessageWithPayload events, None for all other event types.

Trait Implementations§

Source§

impl Clone for PgmqNotifyEvent

Source§

fn clone(&self) -> PgmqNotifyEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PgmqNotifyEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for PgmqNotifyEvent

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for PgmqNotifyEvent

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for PgmqNotifyEvent

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for PgmqNotifyEvent

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,