Struct EventPublisher

pub struct EventPublisher<E> { /* private fields */ }

EventPublisher. Works similarly to C#’s event publishing pattern. Event handling functions are subscribed to the publisher. Whenever the publisher fires an event it calls all subscribed event handler functions. Use event::EventPublisher::::new() to construct

Implementations

impl<E> EventPublisher<E>

pub fn new() -> EventPublisher<E>

Event publisher constructor.

pub fn subscribe_handler(&mut self, handler: fn(&Event<E>))

Subscribes event handler functions to the EventPublisher. INPUT: handler: fn(&Event) handler is a pointer to a function to handle an event of the type E. The function must be capable of handling references to the event type set up by the publisher, rather than the raw event itself. OUTPUT: void

pub fn unsubscribe_handler(&mut self, handler: fn(&Event<E>)) -> bool

Unsubscribes an event handler from the publisher. INPUT: handler: fn(&Event) handler is a pointer to a function to handle an event of the type E. OUTPUT: bool output is a bool of whether or not the function was found in the list of subscribed event handlers and subsequently removed.

pub fn publish_event(&self, event: &Event<E>)

Publishes events, pushing the &Event to all handler functions stored by the event publisher. INPUT: event: &Event Reference to the Event being pushed to all handling functions.