Struct EventBufferManager 

pub struct EventBufferManager<const N: usize> { /* private fields */ }

An ergonomic wrapper over fallibly writing to fixed-size event buffers.

As FixedSizeEventBuffer has a fixed capacity, callers have to handle the scenario where they attempt to push an event into the event buffer but the buffer has no more capacity. This generally involves having to swap it with a new buffer, as well as holding the event around until they acquire the new buffer.

EventBufferManager provides a simple, ergonomic wrapper over a basic pattern of treating the current buffer as an optional value, and handling the logic of ensuring we have a buffer to write into only when actually attempting a write, rather than always holding on to one.

Implementations

impl<const N: usize> EventBufferManager<N>

pub fn try_push(&mut self, event: Event) -> Option<FixedSizeEventBuffer<N>>

Attempts to push an event into the current event buffer.

If the event buffer is full, it is replaced with a new event buffer before pushing the event, and Some(buffer) is returned containing the old event buffer. Otherwise, None is returned.

pub fn consume(&mut self) -> Option<FixedSizeEventBuffer<N>>

Consumes the current event buffer, if one exists.

Trait Implementations

impl<const N: usize> Default for EventBufferManager<N>

fn default() -> EventBufferManager<N>

Returns the “default value” for a type.