Skip to main content

SubscriptionHandle

sourcery_core::subscription

Struct SubscriptionHandle 

Source 
pub struct SubscriptionHandle<StoreError>
where
    StoreError: Error + 'static,
{ /* private fields */ }
Expand description

Handle to a running subscription.

Dropping the handle sends a best-effort stop signal. Call stop() for graceful shutdown and to observe task errors.

Implementations§

Source§

impl<StoreError> SubscriptionHandle<StoreError>
where StoreError: Error + 'static,

Source

pub async fn stop(self) -> Result<(), SubscriptionError<StoreError>>

Stop the subscription gracefully and wait for it to finish.

§Errors

Returns the subscription’s error if it failed before being stopped.

Source

pub fn is_running(&self) -> bool

Check if the subscription task is still running.

Trait Implementations§

Source§

impl<StoreError> Drop for SubscriptionHandle<StoreError>
where StoreError: Error + 'static,

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<StoreError> Freeze for SubscriptionHandle<StoreError>

§

impl<StoreError> !RefUnwindSafe for SubscriptionHandle<StoreError>

§

impl<StoreError> Send for SubscriptionHandle<StoreError>
where StoreError: Send,

§

impl<StoreError> Sync for SubscriptionHandle<StoreError>
where StoreError: Send,

§

impl<StoreError> Unpin for SubscriptionHandle<StoreError>

§

impl<StoreError> !UnwindSafe for SubscriptionHandle<StoreError>

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