Struct lasy::stream::raw::Stream

pub struct Stream<M> { /* fields omitted */ }

A clone-able handle around a raw laser stream.

Methods

impl<M> Stream<M>

pub fn set_point_hz(&self, point_hz: u32) -> Result<(), SendError<()>>

Update the rate at which the DAC should process points per second.

This value should be no greater than the detected DAC's max_point_hz.

By default this value is stream::DEFAULT_POINT_HZ.

pub fn set_latency_points(&self, points: u32) -> Result<(), SendError<()>>

The maximum latency specified as a number of points.

Each time the laser indicates its "fullness", the raw stream will request enough points from the render function to fill the DAC buffer up to latency_points.

This value should be no greaterthan the DAC's buffer_capacity.

pub fn send<F>(&self, update: F) -> Result<(), SendError<ModelUpdate<M>>> where
    F: FnOnce(&mut M) + Send + 'static, 

Send the given model update to the laser thread to be applied ASAP.

If the laser is currently rendering, the update will be applied immediately after the function call completes.

If the stream is currently paused, the update will be applied immediately.

Note: This function will be applied on the real-time laser thread so users should avoid performing any kind of I/O, locking, blocking, (de)allocations or anything that may run for an indeterminate amount of time.

Trait Implementations

impl<M: Clone> Clone for Stream<M>

fn clone(&self) -> Stream<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M> Drop for Stream<M>

fn drop(&mut self)

Executes the destructor for this type.