Struct pharos::ObserveConfig

pub struct ObserveConfig<Event> where
    Event: Clone + 'static + Send,  { /* fields omitted */ }

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.

use pharos::*;

// We choose event type usize for simplicity. You choose whatever type you want here,
// see the bounds on the Event type parameter throughout this library.
//
let mut pharos = Pharos::<usize>::default();

// Use defaults, unbounded channel and no filter.
//
pharos.observe( ObserveConfig::default() );

// Use bounded channel and defaults for other options.
//
pharos.observe( Channel::Bounded(5).into() );

// Use a filter and defaults for other options.
// Will only receive events if they are bigger than three.
//
pharos.observe( Filter::Pointer( |evt| *evt > 3 ).into() );

// Set both channel and filter. Note you can only set one filter per observable.
//
let opts = ObserveConfig::default()

   .channel( Channel::Bounded( 5 ) )
   .filter ( |evt| *evt > 3        )
;

pharos.observe( opts );

Methods

impl<Event> ObserveConfig<Event> where
    Event: Clone + 'static + Send, 

pub fn channel(self, channel: Channel) -> Self

Choose which channel implementation to use for your event stream.

pub fn filter(self, filter: fn(_: &Event) -> bool) -> Self

Filter your event stream with a predicate that is a fn pointer. You can only set one filter per observable.

pub fn filter_boxed(
    self,
    filter: impl FnMut(&Event) -> bool + Send + 'static
) -> Self

Filter your event stream with a predicate that is a closure that captures environment. It is preferred to use filter if you can as this will box the closure. You can only set one filter per observable.

Trait Implementations

impl<Event> Default for ObserveConfig<Event> where
    Event: Clone + 'static + Send, 

Create a default configuration:

• no filter
• an unbounded channel

fn default() -> Self

Returns the "default value" for a type.

impl<Event> From<Channel> for ObserveConfig<Event> where
    Event: Clone + 'static + Send, 

Create a ObserveConfig from a Channel, getting default values for other options.

fn from(channel: Channel) -> Self

Performs the conversion.

impl<Event> From<Filter<Event>> for ObserveConfig<Event> where
    Event: Clone + 'static + Send, 

Create a ObserveConfig from a Filter, getting default values for other options.

fn from(filter: Filter<Event>) -> Self

Performs the conversion.

impl<Event: Debug> Debug for ObserveConfig<Event> where
    Event: Clone + 'static + Send, 

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.