Struct oxygengine_core::ecs::ReaderId

pub struct ReaderId<T> where
    T: 'static,  { /* fields omitted */ }

A reader ID which represents a subscription to the events pushed to the EventChannel.

For each reader ID, the last read event is tracked; this way, the buffer gets grown whenever it would overwrite an event which was not yet observed by every ReaderId.

Dropping a ReaderId effectively cancels the subscription to those events.

Note that as long as a ReaderId exists, it is crucial to use it to read the events; otherwise the buffer of the EventChannel will keep growing.

Trait Implementations

impl<T> Debug for ReaderId<T> where
    T: 'static + Debug, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> Drop for ReaderId<T> where
    T: 'static, 

fn drop(&mut self)

Executes the destructor for this type.