Skip to main content

EventRouter

Struct EventRouter 

Source
pub struct EventRouter { /* private fields */ }
Expand description

In-process station event router.

Implementations§

Source§

impl EventRouter

Source

pub fn new(limits: EventQueueLimits) -> Self

Creates an empty event router.

Source

pub fn register_station(&mut self, station_id: StationId)

Registers a station target queue.

Source

pub fn register_stations(&mut self, stations: &StationSet)

Registers all stations in a set.

Source

pub fn unregister_station(&mut self, station_id: StationId) -> Option<usize>

Unregisters a station queue and returns the number of queued events dropped.

Source

pub fn route( &mut self, event: StationEvent, ) -> Result<PushOutcome, EventRouterError>

Routes an event to its target station queue.

Source

pub fn drain_ready( &mut self, station_id: StationId, current_tick: Tick, ) -> Result<Vec<StationEvent>, EventRouterError>

Drains events whose target_tick is ready for application.

Source

pub fn drain_ready_into( &mut self, station_id: StationId, current_tick: Tick, ready: &mut Vec<StationEvent>, ) -> Result<(), EventRouterError>

Drains ready events into caller-owned storage while retaining its capacity.

Source

pub fn queued_len(&self, station_id: StationId) -> Option<usize>

Returns queued event count for one station.

Source

pub const fn stats(&self) -> EventRouterStats

Returns router statistics.

Trait Implementations§

Source§

impl Clone for EventRouter

Source§

fn clone(&self) -> EventRouter

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EventRouter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EventRouter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.