pharos 0.5.2

Observer pattern which generates a futures 0.3 stream of events
Documentation
use crate::{ import::*, Pharos, PharErr, Observable, Observe, ObserveConfig, Events };


/// A handy wrapper that uses a futures aware mutex to allow using Pharos from a shared
/// reference.
//
#[ derive( Debug, Clone ) ]
//
pub struct SharedPharos<Event> where Event: 'static + Clone + Send
{
	pharos: Arc<Mutex< Pharos<Event> >>,
}


impl<Event> SharedPharos<Event> where Event: 'static + Clone + Send
{
	/// Create a SharedPharos object.
	//
	pub fn new( pharos: Pharos<Event> ) -> Self
	{
		Self{ pharos: Arc::new(Mutex::new( pharos )) }
	}


	/// Notify observers.
	//
	pub async fn notify( &self, evt: Event ) -> Result<(), PharErr>
	{
		let mut ph = self.pharos.lock().await;

		ph.send( evt ).await
	}


	/// Start Observing this Pharos object.
	//
	pub async fn observe_shared( &self, options: ObserveConfig<Event> ) -> Result<Events<Event>, <Self as Observable<Event>>::Error >
	{
		let mut ph = self.pharos.lock().await;

		ph.observe( options ).await
	}
}


impl<Event> Default for SharedPharos<Event>

	where Event: 'static + Clone + Send

{
	fn default() -> Self
	{
		Self::new( Pharos::default() )
	}
}


impl<Event> Observable<Event> for SharedPharos<Event>

	where Event: 'static + Clone + Send
{
	type Error = PharErr;

	fn observe( &mut self, options: ObserveConfig<Event> ) -> Observe< '_, Event, Self::Error >
	{
		self.observe_shared( options ).boxed()
	}
}