rx_core_common 0.2.2

rx_core's core traits and implementations
Documentation
use crate::Teardown;

/// A [TeardownCollection] is something that owns resources that can be
/// released through the [SubscriptionLike] traits `unsubscribe` method.
///
/// [Drop] is mandatory to manually implement for [TeardownCollection], but not
/// for subscribers that do not actually own a teardown, only forward the
/// added teardowns downstream. This is why this bound is only enforced on the
/// [Observable::Subscription][crate::Observable::Subscription].
///
/// It has to be implemented to guarantee that resources are
/// properly released on drop. Note that some subscriptions do not need to
/// do anything on drop. If that's the case, the `drop` fn should only contain
/// a comment on why it doesn't need to do anything.
pub trait TeardownCollection {
	/// Add additional teardowns to execute on unsubscribe. If the subscription
	/// is already closed, the added teardown is immediately executed!
	fn add_teardown(&mut self, teardown: Teardown);
}

pub trait TeardownCollectionExtension: TeardownCollection {
	#[inline]
	fn add<T>(&mut self, teardown: T)
	where
		T: Into<Teardown>,
	{
		self.add_teardown(teardown.into());
	}

	#[inline]
	fn add_fn<F>(&mut self, f: F)
	where
		F: 'static + FnOnce() + Send + Sync,
		Self: Sized,
	{
		self.add(Teardown::new(f));
	}
}

impl<S> TeardownCollectionExtension for S where S: TeardownCollection {}