Struct JobSender 

pub struct JobSender {
    queue: Sender<Job>,
}

A cloneable handle to a world’s job queue.

A world is reached either through the WorldHandle it was spawned with or through the WorldSender its proxy entity carries; both hold one of these. Sends never block: a full or stopped queue reports SendError and the job is dropped.

Fields

queue: Sender<Job>

Implementations

impl JobSender

pub fn watch<T, F>(&self, collect: F) -> Result<SnapshotReader<T>, SendError>

where T: Send + Sync + 'static, F: FnMut(&World) -> Option<T> + Send + 'static,

Watch a snapshot of this world.

collect runs on the world’s own thread once per tick, after its state has been updated, and whatever it returns is published to the reader. Returning None leaves the newest snapshot in place, which is how a collector stays quiet while nothing has changed.

The subscription is a job: it is refused with the queue’s error when the queue is full or the world has stopped, and the returned reader then never sees a snapshot.

Panics

A collector that publishes into its own world — by calling publish_collected — panics on the borrow it takes of the subscription list. A collector only reads the world.

pub fn subscribe<T, F>(&self, collect: F) -> Result<StreamReader<T>, SendError>

where T: Clone + Send + 'static, F: FnMut(&World, &mut Vec<T>) + Send + 'static,

Subscribe to a stream of this world.

collect runs on the world’s own thread once per tick and appends whatever it found to out, which is reused across ticks. Every value reaches every reader’s queue; the reader drains its queue in its own tick with StreamReader::pump.

The subscription is a job: it is refused with the queue’s error when the queue is full or the world has stopped, and the returned reader then never sees a value.

Panics

A collector that publishes into its own world — by calling publish_collected — panics on the borrow it takes of the subscription list. A collector only reads the world.

impl JobSender

pub fn new(queue: Sender<Job>) -> Self

Wrap a world’s command channel.

pub fn send(&self, job: Job) -> Result<(), SendError>

Queue a job. Never blocks.

An Ok means the job is in the queue; whether it runs is the world’s business. A world its owner has asked to stop keeps accepting jobs until its driver’s next turn, and drops them when it ends, so a caller that must know the job ran reads the world’s state instead.

Trait Implementations

impl Clone for JobSender

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.