Struct SignalBus 

pub struct SignalBus { /* private fields */ }

Double-buffered message service owned by a crate::scene::Scene. Each buffer is limited independently, so at most twice capacity() events are retained. Payload sizes are caller-owned; no background/global state exists.

Implementations

impl SignalBus

pub fn with_capacity(capacity: usize) -> Self

Creates an empty bus. A zero capacity deliberately rejects all sends.

pub fn send( &mut self, channel: &str, payload: Value, sender: Option<Entity>, target: Option<Entity>, ) -> Result<u64, SignalError>

Enqueues a broadcast or directed signal for the next simulation frame. Returns its sequence, or a typed rejection without modifying the bus. The host may address any handle; script helpers validate recipient liveness.

pub fn begin_frame(&mut self)

Expires the previous inbox and publishes all pending messages, preserving order. Runtime calls this once before script sync/update, including during single-step.

pub fn incoming(&self) -> &[Signal]

Current delivered snapshot, valid until the next mutable bus operation.

pub fn channel<'a>( &'a self, channel: &'a str, ) -> impl Iterator<Item = &'a Signal>

Messages on one exact channel, in send order, without consuming them.

pub fn for_entity(&self, entity: Entity) -> impl Iterator<Item = &Signal>

Delivered messages visible to one recipient (broadcast plus exact directed target).

pub fn pending_len(&self) -> usize

Pending messages to be delivered at the next frame boundary.

pub fn capacity(&self) -> usize

Maximum event count in each buffer.

pub fn clear(&mut self)

Discards both inbox and pending messages, preserving the sequence and allocations.

Trait Implementations

impl Clone for SignalBus

fn clone(&self) -> SignalBus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignalBus

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

Formats the value using the given formatter.

impl Default for SignalBus

fn default() -> Self

Returns the “default value” for a type.