Struct shrev::EventHandler

pub struct EventHandler { /* fields omitted */ }

Event handler for managing many separate event types.

Methods

impl EventHandler

fn new() -> EventHandler

Create a new EventHandler

fn register<E: Event>(&mut self)

Register an event type.

This will register the event type and allocate ringbuffer storage for the event type with a default max size of 200 events. Once the 200 mark is reached, and a reader has still not read the events, the buffer will overflow, and the reader will get an error on the next read.

fn register_with_size<E: Event>(&mut self, max_size: usize)

Register an event type, with a given maximum number of events before overflowing.

This will register the event type and allocate ringbuffer storage for the event type with the given size. Once that size mark is reached, and a reader has still not read the events, the buffer will overflow, and the reader will get an error on the next read.

fn register_reader<E: Event>(&mut self) -> Result<ReaderId, EventError<E>>

Register a reader of an event type.

To be able to read events, a reader id is required. This is because otherwise the handler wouldn't know where in the ringbuffer the reader has read to earlier. This information is stored in the reader id.

fn write<E: Event>(&mut self, events: &mut Vec<E>) -> Result<(), EventError<E>>

Write a number of events into its storage.

fn write_single<E: Event>(&mut self, event: E) -> Result<(), EventError<E>>

Write a single event into its storage.

fn read<E: Event>(
    &self,
    reader_id: &mut ReaderId
) -> Result<Vec<E>, EventError<E>>

Read any events that have been written to storage since the readers last read.