Skip to main content

PgListenerBuilder

Struct PgListenerBuilder 

Source
pub struct PgListenerBuilder { /* private fields */ }
Expand description

Builder for a PgListener with non-default PgListenerOptions.

Implementations§

Source§

impl PgListenerBuilder

Source

pub fn reconnect(self, reconnect: bool) -> Self

Whether to reconnect after the connection is lost.

Source

pub fn backoff(self, initial: Duration, max: Duration) -> Self

Reconnect backoff: the first delay (non-zero) and the upper bound (at least initial).

Source

pub fn keepalive_idle(self, idle: Duration) -> Self

TCP keepalive idle time on the listener connection (at least 1 s).

Source

pub fn ping_interval(self, interval: Duration) -> Self

Liveness check period (at least 100 ms, at most one day); see PgListenerOptions::ping_interval.

Source

pub fn buffer(self, buffer: usize) -> Self

Capacity of the notification queue (at least 1, at most tokio’s Semaphore::MAX_PERMITS); see PgListenerOptions::buffer.

Source

pub fn max_reconnect_attempts(self, attempts: impl Into<Option<u32>>) -> Self

Give up after attempts failed reconnect attempts in a row (None: never); see PgListenerOptions::max_reconnect_attempts.

Source

pub fn options(self, options: PgListenerOptions) -> Self

Replace all options at once.

Source

pub async fn connect(self) -> PgResult<PgListener>

Open the listener connection.

Fails if the options are invalid, the TLS configuration is unusable (see the pool’s ssl_mode rules), or the connection cannot be established. The attempt, including the TLS and startup handshake, is bounded by PgConfig::connect_timeout plus PgListenerOptions::ping_interval; past that it fails with a connection error.

Trait Implementations§

Source§

impl Clone for PgListenerBuilder

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 PgListenerBuilder

Shows the options only: the config holds the password.

Source§

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

Formats the value using the given formatter. Read more

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