rx_core_common 0.2.2

use std::fmt::Debug;

use disqualified::ShortName;

use crate::{Scheduler, SchedulerHandle, SubscriptionLike, WorkCancellationId, WorkInvokeId};

/// 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:
///
/// ```rs
/// 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.
#[derive(Default)]
pub struct Teardown {
	teardown_fn: Option<Box<dyn FnOnce() + Send + Sync>>,
}

impl PartialEq for Teardown {
	fn eq(&self, other: &Self) -> bool {
		self.is_closed() == other.is_closed()
	}
}

impl Debug for Teardown {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		f.write_fmt(format_args!(
			"{} {{ is_closed: {} }}",
			ShortName::of::<Self>(),
			self.is_closed(),
		))
	}
}

impl Teardown {
	pub fn new<F>(f: F) -> Self
	where
		F: 'static + FnOnce() + Send + Sync,
	{
		Self {
			teardown_fn: Some(Box::new(f)),
		}
	}

	pub fn new_from_box(f: Box<dyn FnOnce() + Send + Sync>) -> Self {
		Self {
			teardown_fn: Some(f),
		}
	}

	#[inline]
	pub fn new_work_cancellation<S: 'static + Scheduler>(
		cancellation_id: WorkCancellationId,
		scheduler: SchedulerHandle<S>,
	) -> Self {
		Teardown::new(move || scheduler.lock().cancel(cancellation_id))
	}

	#[inline]
	pub fn new_work_invokation<S: 'static + Scheduler>(
		invoke_id: WorkInvokeId,
		scheduler: SchedulerHandle<S>,
	) -> Self {
		Teardown::new(move || scheduler.lock().invoke(invoke_id))
	}

	#[inline]
	pub fn new_invoked_work_cancellation<S: 'static + Scheduler>(
		invoke_id: WorkInvokeId,
		scheduler: SchedulerHandle<S>,
	) -> Self {
		Teardown::new(move || scheduler.lock().cancel_invoked(invoke_id))
	}

	/// Invokes one work and cancels another in a single teardown.
	#[inline]
	pub fn new_work_invokation_and_cancellation<S: 'static + Scheduler>(
		invoke_id: WorkInvokeId,
		cancellation_id: WorkCancellationId,
		scheduler: SchedulerHandle<S>,
	) -> Self {
		Teardown::new(move || {
			let mut scheduler = scheduler.lock();
			scheduler.invoke(invoke_id);
			scheduler.cancel(cancellation_id);
		})
	}

	/// 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.
	#[inline]
	pub fn take(mut self) -> Option<Box<dyn FnOnce() + Send + Sync>> {
		self.teardown_fn.take()
	}

	/// Immediately consumes and calls the teardowns closure, leaving a None
	/// behind, rendering the teardown permamently closed.
	#[inline]
	pub fn execute(mut self) {
		if let Some(teardown) = self.teardown_fn.take() {
			(teardown)();
		}
	}

	#[inline]
	pub fn is_closed(&self) -> bool {
		self.teardown_fn.is_none()
	}
}

/// 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.
impl<S> From<S> for Teardown
where
	S: 'static + SubscriptionLike + Send + Sync,
{
	fn from(mut subscription: S) -> Self {
		Self {
			teardown_fn: if subscription.is_closed() {
				None
			} else {
				let closure = move || subscription.unsubscribe();
				Some(Box::new(closure))
			},
		}
	}
}