Struct MainThreadPump 

pub struct MainThreadPump { /* private fields */ }

Cooperative pump that drains main-thread work items on demand.

MainThreadPump is Clone — all clones share the same underlying queue. The instance that calls pump must be on the affinity thread.

Thread safety

dispatch is safe to call from any thread. pump must be called from the thread that “owns” the pump (typically the DCC main / UI thread).

Implementations

impl MainThreadPump

pub fn new() -> Self

Create a new pump with an unbounded internal queue.

pub fn dispatch<F>(&self, f: F)

where F: FnOnce() + Send + 'static,

Dispatch a closure to run on the affinity thread.

Returns immediately; the closure will be executed on the next pump call.

Panics

Panics if the pump has been dropped (the receiver end is gone). In normal usage this never happens while any clone is alive.

pub fn pump(&self, budget: Duration) -> PumpStats

Drain pending work items for up to budget wall-clock time.

Call this from the host’s idle / update callback. The pump will process as many items as possible within the budget without over-running it (each item runs to completion; the budget is checked between items).

Returns PumpStats describing what happened.

pub fn pending(&self) -> usize

Number of work items currently waiting to be pumped.

pub fn total_dispatched(&self) -> u64

Total number of closures ever dispatched since this pump was created.

pub fn total_processed(&self) -> u64

Total number of closures ever processed since this pump was created.

Trait Implementations

impl Clone for MainThreadPump

fn clone(&self) -> MainThreadPump

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for MainThreadPump

fn default() -> Self

Returns the “default value” for a type.