Struct StreamControl 

pub struct StreamControl { /* private fields */ }

Thread-safe control handle for safety-critical actions.

This allows out-of-band control of the stream (arm/disarm/stop) from a different thread, e.g., for E-stop functionality.

Control actions take effect as soon as possible - the stream processes control messages at every opportunity (during waits, between retries, etc.).

Implementations

impl StreamControl

pub fn arm(&self) -> Result<()>

Arm the output (allow laser to fire).

When armed, content from the producer passes through unmodified and the hardware shutter is opened (best-effort).

pub fn disarm(&self) -> Result<()>

Disarm the output (force laser off). Designed for E-stop use.

Immediately sets an atomic flag (works even if stream loop is blocked), then sends a message to close the hardware shutter. All future points are blanked in software. The stream stays alive outputting blanks - use stop() to terminate entirely.

Latency: Points already in the device buffer will still play out. target_queue_points bounds this latency.

Hardware shutter: Best-effort. LaserCube and Helios have actual hardware control; Ether Dream, IDN are no-ops (safety relies on software blanking).

pub fn is_armed(&self) -> bool

Check if the output is armed.

pub fn stop(&self) -> Result<()>

Request the stream to stop.

Signals termination; run() returns RunExit::Stopped. For clean shutdown with shutter close, prefer Stream::stop().

pub fn is_stop_requested(&self) -> bool

Check if a stop has been requested.

Trait Implementations

impl Clone for StreamControl

fn clone(&self) -> StreamControl

Returns a duplicate of the value.

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

Performs copy-assignment from source.