Crate pharos

pharos

An introduction to pharos is available in many formats: video, wikipedia and it was even honored by many artists like this painting by Micheal Turner.

More seriously, pharos is a small observer library that let's you create futures 0.3 streams that observers can listen to.

I created it to leverage interoperability we can create by using async Streams and Sinks from the futures library. So you can use all stream combinators, forward it into Sinks and so on.

Minimal rustc version: 1.39.

Table of Contents

• Security
• Limitations
• Future work
• Install
  • Upgrade
  • Dependencies
• Usage
  • Filter
• API
• Contributing
  • Code of Conduct
• License

Security

The main issue with this crate right now is the possibility for the observable to outpace the observer. When using bounded channels, there is back pressure, which might allow DDOS attacks if using the pattern on arriving network packets. When using the unbounded channels, it might lead to excessive memory consumption if observers are outpaced.

TODO: To mitigate these problems effectively, I will add a ring channel where the channel will only buffer a certain amount events and will overwrite the oldest event instead of blocking the sender when the buffer is full.

This crate has: #![ forbid( unsafe_code ) ]

Limitations

• only bounded and unbounded channel as back-end (for now)
• Events is not clonable right now (would require support from the channels we use as back-ends, eg. broadcast type channel)
• performance tweaking still needs to be done
• pharos requires mut access for most operations. This is not intended to change anytime soon. Both on notify and observe, the two main interfaces, manipulate internal state, and most channels also require mutable access to either read or write. If you need it from non mutable context, use interior mutability primitives like locks or Cells...

Future work

Please check out the todo for ambitions.

Install

With cargo add: cargo add pharos

With cargo yaml:

dependencies:

  pharos: ^0.3

With raw Cargo.toml

[dependencies]

   pharos = "0.3"

Upgrade

Please check out the changelog when upgrading.

Dependencies

This crate only has two dependencies. Cargo will automatically handle it's dependencies for you.

dependencies:

  futures-preview : { version: ^0.3.0-alpha, features: [async-await, nightly] }
  pin-project     : ^0.4.0-beta

Usage

pharos only works for async code, as the notify method is asynchronous. Observers must consume the messages fast enough, otherwise they will slow down the observable (bounded channel) or cause memory leak (unbounded channel).

Whenever observers want to unsubscribe, they can just drop the stream or call close on it. If you are an observable and you want to notify observers that no more messages will follow, just drop the pharos object. Failing that, create an event type that signifies EOF and send that to observers.

Your event type will be cloned once for each observer, so you might want to put it in an Arc if it's bigger than a pointer size (eg. there's no point putting an enum without data in an Arc).

Examples can be found in the examples directory. Here is the most basic one:

use
{
   pharos  :: { *                             } ,
   futures :: { executor::block_on, StreamExt } ,
};


// here we put a pharos object on our struct
//
struct Goddess { pharos: Pharos<GoddessEvent> }


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

   // Send Goddess sailing so she can tweet about it!
   //
   pub async fn sail( &mut self )
   {
      self.pharos.notify( &GoddessEvent::Sailing ).await;
   }
}


// Event types need to implement clone, but you can wrap them in Arc if not. Also they will be
// cloned, so if you will have several observers and big event data, putting them in an Arc is
// definitely best. It has no benefit to put a simple dataless enum in an Arc though.
//
#[ derive( Clone, Debug, PartialEq, Copy ) ]
//
enum GoddessEvent
{
   Sailing
}


// This is the needed implementation of Observable. We might one day have a derive for this,
// but it's not so interesting, since you always have to point it to your pharos object,
// and when you want to be observable over several types of events, you might want to keep
// pharos in a hashmap over type_id, and a derive would quickly become a mess.
//
impl Observable<GoddessEvent> for Goddess
{
   fn observe( &mut self, options: ObserveConfig<GoddessEvent>) -> Events<GoddessEvent>
   {
      self.pharos.observe( options )
   }
}


fn main()
{
   let program = async move
   {
      let mut isis = Goddess::new();

      // subscribe, the observe method takes options to let you choose:
      // - channel type (bounded/unbounded)
      // - a predicate to filter events
      //
      let mut events = isis.observe( Channel::Bounded( 3 ).into() );

      // trigger an event
      //
      isis.sail().await;

      // read from stream and let's put on the console what the event looks like.
      //
      let evt = dbg!( events.next().await.unwrap() );

      // After this reads on the event stream will return None.
      //
      drop( isis );

      assert_eq!( GoddessEvent::Sailing, evt );
      assert_eq!( None, events.next().await );
   };

   block_on( program );
}

Filter

Sometimes you are not interested in all event types an observable can emit. A common use case is only listening for a close event on a network connection. The observe method takes options which let you set the predicate. You can only set one predicate for a given observer.

use pharos::*;

#[ derive( Clone, Debug, PartialEq, Copy ) ]
//
enum NetworkEvent
{
   Open    ,
   Error   ,
   Closing ,
   Closed  ,
}

struct Connection { pharos: Pharos<NetworkEvent> }

impl Observable<NetworkEvent> for Connection
{
   fn observe( &mut self, options: ObserveConfig<NetworkEvent>) -> Events<NetworkEvent>
   {
       self.pharos.observe( options )
   }
}

fn main()
{
   let mut conn = Connection{ pharos: Pharos::default() };

   // We will only get close events.
   //
   let filter = Filter::Pointer( |e| e == &NetworkEvent::Closed );

   // By creating the config object through into, other options will be defaults, notably here
   // this will use unbounded channels.
   //
   let observer = conn.observe( filter.into() );

   // Combine both options.
   //
   let filter = Filter::Pointer( |e| e != &NetworkEvent::Closed );
   let opts   = ObserveConfig::from( filter ).channel( Channel::Bounded(5) );

   // Get everything but close events over a bounded channel with queue size 5.
   //
   let bounded_observer = conn.observe( opts );
}

API

API documentation can be found on docs.rs.

Contributing

This repository accepts contributions. Ideas, questions, feature requests and bug reports can be filed through Github issues.

Pull Requests are welcome on Github. By committing pull requests, you accept that your code might be modified and reformatted to fit the project coding style or to improve the implementation. Please discuss what you want to see modified before filing a pull request if you don't want to be doing work that might be rejected.

Code of conduct

Any of the behaviors described in point 4 "Unacceptable Behavior" of the Citizens Code of Conduct are not welcome here and might get you banned. If anyone including maintainers and moderators of the project fail to respect these/your limits, you are entitled to call them out.

License

Unlicence

Structs

Events	A stream of events. This is returned from Observable::observe.
ObserveConfig	Configuration for your event stream, passed to Observable::observe when subscribing. This let's you choose the type of channel and let's you set a filter to ignore certain events.
Pharos	The Pharos lighthouse. When you implement Observable on your type, you can forward the observe method to Pharos and call notify on it.

Enums

Channel

Choose the type of channel that will be used for your event stream. Used in ObserveConfig.

Filter

Predicate for filtering events. This is an enum because closures that capture variables from their environment need to be boxed. More often than not, an event will be a simple enum and the predicate will just match on the variant, so it would be wasteful to impose boxing in those cases, hence there is a function pointer variant which does not require boxing. This should be preferred where possible.

Traits

Observable

Indicate that a type is observable. You can call observe to get a stream of events.