Skip to main content

PgListenerEvent

Enum PgListenerEvent 

Source
#[non_exhaustive]
pub enum PgListenerEvent { Notification(PgNotification),
#[non_exhaustive]
Disconnected { error: String, }, Reconnected,
#[non_exhaustive]
Lagged { dropped: u64, },
#[non_exhaustive]
ChannelsDropped { channels: Vec<String>, }, }
Expand description

An event delivered by PgListener::recv.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Notification(PgNotification)

A notification on a channel this listener is subscribed to.

§

#[non_exhaustive]
Disconnected

The connection was lost and the listener is reconnecting (only with PgListenerOptions::reconnect enabled). Notifications sent while it is disconnected are missed until the Reconnected that follows. Reported once per outage, as soon as the loss is detected, so an application can react while reconnecting is still failing; if reconnecting gives up, PgListener::recv returns the error instead of a Reconnected. Not reported when the listener is dropped.

Notifications the lost connection had already received can still be returned after this event (when the loss was detected by an unanswered ping or command, the old connection’s buffered messages may be decoded and queued while its driver task is being stopped). They always come before the Reconnected.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§error: String

Why the connection was lost, for logs.

§

Reconnected

The connection was lost and re-established; notifications sent in between were missed. Resynchronise any state derived from them.

§

#[non_exhaustive]
Lagged

The notification queue overflowed and dropped notifications were discarded. Resynchronise any state derived from them.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§dropped: u64

Number of notifications discarded since the last report.

§

#[non_exhaustive]
ChannelsDropped

After a reconnect, the server refused to subscribe these channels again (for example names its encoding cannot represent); they are no longer tracked and receive nothing until listened to again. Reported right before the Reconnected of that reconnect.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§channels: Vec<String>

The channels that were dropped, in no particular order.

Implementations§

Source§

impl PgListenerEvent

Constructors for the #[non_exhaustive] variants, for tests and fakes of code that consumes PgListenerEvents (like PgNotification::new).

Source

pub fn disconnected(error: impl Into<String>) -> Self

A Disconnected event with this cause.

Source

pub fn lagged(dropped: u64) -> Self

A Lagged event reporting dropped notifications.

Source

pub fn channels_dropped<I, S>(channels: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

A ChannelsDropped event for channels.

Trait Implementations§

Source§

impl Clone for PgListenerEvent

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PgListenerEvent

Source§

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

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

impl Eq for PgListenerEvent

Source§

impl PartialEq for PgListenerEvent

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PgListenerEvent

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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<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