Skip to main content

Subscription

Struct Subscription 

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

Controls a registered callback subscription.

Dropping this handle unsubscribes immediately and without waiting for a callback worker. Use Subscription::close when the caller must await the retirement of an already running callback and observe any callback fault.

Implementations§

Source§

impl Subscription

Source

pub fn id(&self) -> SubscriptionId

Return the identifier of the controlled subscription.

Source

pub fn is_active(&self) -> bool

Report whether the subscription is still accepting deliveries.

Source

pub fn unsubscribe(&self) -> bool

Prevent future deliveries and release the subscription’s capacity.

This operation is synchronous and idempotent. It does not wait for a callback that is already running to finish.

Source

pub async fn close(self) -> Result<()>

Unsubscribe and wait for callback execution to retire.

When awaited outside subscription callbacks, the returned error preserves a callback panic or dispatch failure. A successful result means the callback is no longer running; it does not imply that a previously delivered callback completed application work after returning control to the SDK.

Polling this future on a thread currently executing any synchronous subscription callback first unsubscribes, then returns ErrorKind::InvalidInput with field subscription.close and stage crate::error::ErrorStage::Dispatch. This also applies when closing a different or already idle subscription, to prevent callbacks from waiting for each other. This error does not guarantee that the callback has retired. Use CallbackContext::unsubscribe inside a callback and retain the subscription handle outside it when retirement must be awaited.

The check runs on every poll, not when the future is created. A future created in a callback can be awaited outside it after the callback returns. The check only sees the current thread’s subscription callback stack; do not wait in a callback for another thread or task that is closing it. Cancelling this future does not reactivate the subscription or interrupt an already running callback.

Trait Implementations§

Source§

impl Debug for Subscription

Source§

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

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

impl Drop for Subscription

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

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