Skip to main content

NotificationSubscription

Struct NotificationSubscription 

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

An idle listener independent of the query session that created it. Close every retained handle before replacing a database file.

Implementations§

Source§

impl NotificationSubscription

Source

pub fn identity(&self) -> &NotificationIdentity

Source

pub fn poll( &self, ) -> Result<Poll<Option<NotificationEvent>>, NotificationSubscriptionError>

No database read, SQL execution or blocking receive is performed by this poll.

Source

pub fn wait( &self, timeout: Duration, ) -> Result<NotificationWait, NotificationSubscriptionError>

Receive without the caller’s transaction or SQL timeout. Timeout leaves this listener registered.

Source

pub fn poll_with<T, E: From<NotificationSubscriptionError>>( &self, prepare: impl FnOnce(&SQLNotification) -> Result<T, E>, ) -> Result<NotificationReceive<T>, E>

Poll with fallible destination admission under the inbox lock. prepare runs at most once, only for a present event, and must not reenter this inbox or Engine. It may reserve storage; it must not invoke host callbacks. Failure or unwinding preserves the event and sequence.

Source

pub fn wait_with<T, E: From<NotificationSubscriptionError>>( &self, timeout: Duration, prepare: impl FnOnce(&SQLNotification) -> Result<T, E>, ) -> Result<NotificationReceive<T>, E>

Wait with the same admission contract as Self::poll_with. Timeout and closure do not invoke prepare; all ordinary native receive and retained-failure semantics remain intact.

Source

pub async fn next_event( &self, ) -> Result<Option<NotificationEvent>, NotificationSubscriptionError>

Receive without blocking a thread or requiring a particular async runtime. At most one asynchronous receive may be pending; another returns InvalidRequest. Dropping a pending receive releases its wake slot without consuming an event or closing the listener.

Source

pub fn is_closed(&self) -> bool

Source

pub fn role_identity(&self) -> RoleIdentity

Preserve the exact effective SQL role selected at registration, including its incarnation.

Source

pub fn stop_delivery(&self)

End delivery and wake receivers without provider I/O. Runtime adapters must still call close off their event-loop worker and wait for it to finish; this signal retains registration resources and admission until that cleanup completes.

Source

pub fn close(&self)

Stop delivery and wake a blocked receiver before releasing only this listener’s retained resources. Concurrent callers wait for that same cleanup to complete.

Trait Implementations§

Source§

impl Drop for NotificationSubscription

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = !

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.