Skip to main content

LifecycleHooks

Struct LifecycleHooks 

Source
#[non_exhaustive]
pub struct LifecycleHooks<C> { pub on_create: Option<Box<dyn Fn(&C) + Send + Sync>>, pub before_acquire: Option<Box<dyn Fn() + Send + Sync>>, pub on_checkout: Option<Box<dyn Fn(&C) + Send + Sync>>, pub on_checkin: Option<Box<dyn Fn(&C) + Send + Sync>>, pub after_release: Option<Box<dyn Fn() + Send + Sync>>, pub on_destroy: Option<Box<dyn Fn() + Send + Sync>>, }
Expand description

Lifecycle hook callbacks. All hooks are optional.

Connection-aware hooks (on_create, on_checkout, on_checkin) receive a &C reference to the connection. Non-connection hooks (before_acquire, after_release, on_destroy) take no parameters — on_destroy because the connection may be invalid, and before_acquire/after_release because no specific connection is involved yet.

Marked #[non_exhaustive] so additional hooks can be introduced in future minor releases without breaking downstream construction.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§on_create: Option<Box<dyn Fn(&C) + Send + Sync>>

Called after a new connection is created.

§before_acquire: Option<Box<dyn Fn() + Send + Sync>>

Called before attempting to acquire a connection (checkout starts).

§on_checkout: Option<Box<dyn Fn(&C) + Send + Sync>>

Called when a connection is checked out and ready to use.

§on_checkin: Option<Box<dyn Fn(&C) + Send + Sync>>

Called when a connection passes health checks and is about to return to the pool.

§after_release: Option<Box<dyn Fn() + Send + Sync>>

Called after a connection is fully released (all exit paths from return).

§on_destroy: Option<Box<dyn Fn() + Send + Sync>>

Called when a connection is destroyed (expired, invalid, or during drain).

Trait Implementations§

Source§

impl<C> Debug for LifecycleHooks<C>

Source§

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

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

impl<C> Default for LifecycleHooks<C>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<C> Freeze for LifecycleHooks<C>

§

impl<C> !RefUnwindSafe for LifecycleHooks<C>

§

impl<C> Send for LifecycleHooks<C>

§

impl<C> Sync for LifecycleHooks<C>

§

impl<C> Unpin for LifecycleHooks<C>

§

impl<C> UnsafeUnpin for LifecycleHooks<C>

§

impl<C> !UnwindSafe for LifecycleHooks<C>

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