Struct Teardown 

pub struct Teardown { /* private fields */ }

A teardown is a closure which owns resources, by the nature of them being moved into said closure. The closure itself is responsible for releasing these resources.

For example if this resource was a subscription, the closure looks like this:

move |context| subscription.unsubscribe(context)

Just like subscriptions, a teardown once closed cannot be opened again.

Teardown intentionally does not implement SubscriptionLike to facilitate the [SubscriptionCollection][crate::SubscriptionCollection] trait which uses Teardown as the base type of operation. Allowing generic functions where you can add anything that is Into<Teardown> such as Subscriptions.

Implementations

impl Teardown

pub fn new<F>(f: F) -> Teardown

where F: 'static + FnOnce() + Send + Sync,

pub fn new_from_box(f: Box<dyn FnOnce() + Send + Sync>) -> Teardown

pub fn new_work_cancellation<S>( cancellation_id: WorkCancellationId, scheduler: SchedulerHandle<S>, ) -> Teardown

where S: 'static + Scheduler,

pub fn new_work_invokation<S>( invoke_id: WorkInvokeId, scheduler: SchedulerHandle<S>, ) -> Teardown

where S: 'static + Scheduler,

pub fn new_invoked_work_cancellation<S>( invoke_id: WorkInvokeId, scheduler: SchedulerHandle<S>, ) -> Teardown

where S: 'static + Scheduler,

pub fn new_work_invokation_and_cancellation<S>( invoke_id: WorkInvokeId, cancellation_id: WorkCancellationId, scheduler: SchedulerHandle<S>, ) -> Teardown

where S: 'static + Scheduler,

Invokes one work and cancels another in a single teardown.

pub fn take(self) -> Option<Box<dyn FnOnce() + Send + Sync>>

Consumes the Teardown without executing it, returning the stored function if it wasn’t already closed. Used when the stored function is moved to somewhere else, like into a subscription.

It’s private to ensure that it’s not taken without either executing it or placing it somewhere else where execution is also guaranteed.

pub fn execute(self)

Immediately consumes and calls the teardowns closure, leaving a None behind, rendering the teardown permamently closed.

pub fn is_closed(&self) -> bool

Trait Implementations

impl Debug for Teardown

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

Formats the value using the given formatter.

impl Default for Teardown

fn default() -> Teardown

Returns the “default value” for a type.

impl<S> From<S> for Teardown

where S: 'static + SubscriptionLike + Send + Sync,

Exposes and respects the original subscriptions closed-ness by storing it in an option.

This means that when you convert an already closed subscription into a teardown, it will be immediately dropped.

fn from(subscription: S) -> Teardown

Converts to this type from the input type.

impl PartialEq for Teardown

fn eq(&self, other: &Teardown) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.