Struct Events 

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

A double-buffered event queue: events stay readable for two frames.

Implementations

impl<E> Events<E>

pub fn new() -> Events<E>

An empty queue.

pub fn send(&mut self, event: E)

Queue an event. It becomes visible to readers immediately and stays readable until the second update after this one.

pub fn update(&mut self)

Advance one frame: retire the older buffer and start a fresh newest one. Events older than two cycles are dropped.

pub fn read(&self, cursor: &mut EventCursor) -> impl Iterator<Item = &E>

Read every buffered event the cursor has not yet seen, in send order, and advance the cursor past them.

Lazy: a drain costs no allocation, which matters because every event reader does this every frame. The cursor advances here rather than as the iterator is consumed, so a caller that reads only part of the run still ends up past all of it – the same thing a returned collection did, and the only behaviour that makes “every reader sees every event exactly once” hold for a partial read.

pub fn len(&self) -> usize

Total events currently buffered across both frames.

pub fn is_empty(&self) -> bool

Whether both frame buffers are empty.

Trait Implementations

impl<E> Default for Events<E>

fn default() -> Events<E>

Returns the “default value” for a type.