pub struct CallbackSubscriptionHandle { /* private fields */ }Expand description
Handle for a callback-based subscription.
Provides lifecycle management (pause/resume/cancel) for the callback task.
The handle and the callback task share the same SubscriptionEntry in
the registry (via SubscriptionId), so pause() / cancel() on the
handle directly affects the task’s event delivery.
Dropping the handle automatically cancels the subscription and aborts the callback task.
Implementations§
Source§impl CallbackSubscriptionHandle
impl CallbackSubscriptionHandle
Sourcepub fn pause(&self) -> bool
pub fn pause(&self) -> bool
Pauses the subscription.
While paused, events are buffered or dropped per the backpressure
configuration. Returns true if the subscription was active and is
now paused.
Sourcepub fn resume(&self) -> bool
pub fn resume(&self) -> bool
Resumes a paused subscription.
Returns true if the subscription was paused and is now active.
Sourcepub fn cancel(&mut self)
pub fn cancel(&mut self)
Cancels the subscription and aborts the callback task.
The subscription is removed from the registry (dropping the broadcast sender) and the task is aborted as a safety net.
Sourcepub fn id(&self) -> SubscriptionId
pub fn id(&self) -> SubscriptionId
Returns the subscription ID.
Sourcepub fn metrics(&self) -> Option<SubscriptionMetrics>
pub fn metrics(&self) -> Option<SubscriptionMetrics>
Returns subscription metrics from the registry.
Sourcepub fn is_cancelled(&self) -> bool
pub fn is_cancelled(&self) -> bool
Returns true if the subscription has been cancelled.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for CallbackSubscriptionHandle
impl RefUnwindSafe for CallbackSubscriptionHandle
impl Send for CallbackSubscriptionHandle
impl Sync for CallbackSubscriptionHandle
impl Unpin for CallbackSubscriptionHandle
impl UnwindSafe for CallbackSubscriptionHandle
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
Source§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
Source§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
out indicating that a T is niched.