Struct EventSink 

pub struct EventSink { /* private fields */ }

A list the core pushes events into while it handles a frame or a timeout.

A core receives &mut EventSink in BrokerCore::on_frame and BrokerCore::on_timeout. The caller reads and empties it afterwards. Events keep the order in which they were pushed.

Examples

use brokapi_core::{Event, SubscriptionId};
use brokapi_sansio::EventSink;

let mut sink = EventSink::new();
assert!(sink.is_empty());

sink.push_payload(Some(SubscriptionId::new(1)), Event::Balances(vec![]));
assert_eq!(sink.len(), 1);
assert_eq!(sink.events()[0].sub, Some(SubscriptionId::new(1)));

// Draining hands the events over and leaves the sink empty.
let events = sink.drain();
assert_eq!(events.len(), 1);
assert!(sink.is_empty());

Implementations

impl EventSink

pub fn new() -> Self

Creates an empty sink.

pub fn push(&mut self, event: CoreEvent)

Appends an event.

pub fn push_payload(&mut self, sub: Option<SubscriptionId>, payload: Event)

Appends an event built from its parts.

pub fn is_empty(&self) -> bool

Whether no event is waiting.

pub fn len(&self) -> usize

How many events are waiting.

pub fn events(&self) -> &[CoreEvent]

The waiting events, oldest first. They stay in the sink.

pub fn drain(&mut self) -> Vec<CoreEvent>

Takes all waiting events out, oldest first, and leaves the sink empty.

Trait Implementations

impl Clone for EventSink

fn clone(&self) -> EventSink

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EventSink

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

Formats the value using the given formatter.

impl Default for EventSink

fn default() -> EventSink

Returns the “default value” for a type.