1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

//!
//! `flo_stream` is a crate providing some extra utilities for streams in Rust's `futures` library, in particular the 'pubsub' pattern.
//! 
//! The primary new feature is a "pubsub" mechanism - a way to subscribe to updates sent to a futures `Sink`. This differs 
//! from the `Sender`/`Receiver` mechanism provided in the main futures library in two key ways: it's possible to have 
//! multiple receivers, and messages sent when there is no subscriber connected will be ignored.
//! 
//! ## PubSub
//! 
//! The sink type provided is `Publisher`. You can create one with `let publisher = Publisher::new(10)`. This implements 
//! the `Sink` trait so can be used in a very similar way to send messages. The number passed in is the maximum number
//! of waiting messages allowed for any given subscriber.
//! 
//! A subscription can be created using `let subscription = publisher.subscribe()`. Any messages sent to the sink after
//! this is called is relayed to all subscriptions. A subscription is a `Stream` so can interact with other parts of the
//! futures library in the usual way.
//! 
//! Here's a full worked example with a single subscriber.
//! 
//! ```
//! # extern crate flo_stream;
//! # extern crate futures;
//! # use flo_stream::*;
//! # use futures::executor;
//! let publisher       = Publisher::new(10);
//! let mut publisher   = executor::spawn(publisher);
//! 
//! let subscriber      = publisher.subscribe();
//! let mut subscriber  = executor::spawn(subscriber);
//! 
//! publisher.wait_send(1).unwrap();
//! publisher.wait_send(2).unwrap();
//! publisher.wait_send(3).unwrap();
//! 
//! assert!(subscriber.wait_stream() == Some(Ok(1)));
//! assert!(subscriber.wait_stream() == Some(Ok(2)));
//! assert!(subscriber.wait_stream() == Some(Ok(3)));
//! ```

#![warn(bare_trait_objects)]

extern crate futures;

mod publisher_sink;
mod publisher;
mod blocking_publisher;
mod single_publisher;
mod expiring_publisher;
mod subscriber;
mod pubsub_core;
mod spawn;

pub use self::publisher_sink::*;
pub use self::publisher::*;
pub use self::expiring_publisher::*;
pub use self::blocking_publisher::*;
pub use self::single_publisher::*;
pub use self::subscriber::*;
pub use self::spawn::*;