Struct WindowChannel 

pub struct WindowChannel { /* private fields */ }

Thread-safe cross-window communication channel.

Messages sent to a WindowId are queued until the window drains them via drain_messages. The channel is cheaply cloneable via Clone (backed by an Arc).

Implementations

impl WindowChannel

pub fn new() -> Self

Create a new, empty channel.

pub fn send( &self, to: WindowId, payload: impl Into<String>, ) -> Result<(), UiError>

Enqueue a message for the target window.

Errors

Returns UiError::Focus when the internal lock is poisoned (extremely rare; only occurs after a panic inside drain_messages).

pub fn drain_messages(&self, id: WindowId) -> Result<Vec<String>, UiError>

Drain all queued messages for the given window, returning them in arrival order. The internal queue for that window is cleared.

Errors

Returns UiError::Focus when the lock is poisoned.

pub fn pending_count(&self, id: WindowId) -> usize

Return the number of pending messages for a window without consuming them.

Trait Implementations

impl Clone for WindowChannel

fn clone(&self) -> WindowChannel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WindowChannel

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

Formats the value using the given formatter.

impl Default for WindowChannel

fn default() -> WindowChannel

Returns the “default value” for a type.