Struct SubscriptionGuard

Source
pub struct SubscriptionGuard<T: SubscriptionLike>(/* private fields */);
Expand description

An RAII implementation of a “scoped subscribed” of a subscription. When this structure is dropped (falls out of scope), the subscription will be unsubscribed.

Implements the [must_use]( https://doc.rust-lang.org/reference/attributes/diagnostics.html #the-must_use-attribute) attribute

If you want to drop it immediately, wrap it in its own scope

Implementations§

Source§

impl<T: SubscriptionLike> SubscriptionGuard<T>

Source

pub fn new(subscription: T) -> SubscriptionGuard<T>

Wraps an existing subscription with a guard to enable RAII behavior for it.

Trait Implementations§

Source§

impl<T: Debug + SubscriptionLike> Debug for SubscriptionGuard<T>

Source§

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

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

impl<T: SubscriptionLike> Drop for SubscriptionGuard<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for SubscriptionGuard<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for SubscriptionGuard<T>
where T: RefUnwindSafe,

§

impl<T> Send for SubscriptionGuard<T>
where T: Send,

§

impl<T> Sync for SubscriptionGuard<T>
where T: Sync,

§

impl<T> Unpin for SubscriptionGuard<T>
where T: Unpin,

§

impl<T> UnwindSafe for SubscriptionGuard<T>
where T: UnwindSafe,

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