Struct ControllerBuilder

pub struct ControllerBuilder { /* private fields */ }

A builder for creating a Controller instance.

Implementations

impl ControllerBuilder

pub fn devices(self) -> Vec<Device>

Takes the devices out of the builder.

pub const fn default_parallel_threshold(&self) -> usize

The default parallel threshold when no threshold is specified for the [Datagram] to be sent. The default value is 4.

pub const fn default_timeout(&self) -> Duration

The default timeout when no timeout is specified for the [Datagram] to be sent. The default value is 20ms.

pub const fn send_interval(&self) -> Duration

The duration between sending operations. The default value is 1ms.

pub const fn receive_interval(&self) -> Duration

The duration between receiving operations. The default value is 1ms.

pub const fn timer_strategy(&self) -> &TimerStrategy

The strategy used for timing operations. The default value is TimerStrategy::Spin with the default SpinSleeper.

impl ControllerBuilder

pub const fn with_default_parallel_threshold( self, default_parallel_threshold: usize, ) -> Self

Set the default_parallel_threshold field.

pub const fn with_default_timeout(self, default_timeout: Duration) -> Self

Set the default_timeout field.

pub const fn with_send_interval(self, send_interval: Duration) -> Self

Set the send_interval field.

pub const fn with_receive_interval(self, receive_interval: Duration) -> Self

Set the receive_interval field.

pub const fn with_timer_strategy(self, timer_strategy: TimerStrategy) -> Self

Set the timer_strategy field.

impl ControllerBuilder

pub fn open<B: LinkBuilder>( self, link_builder: B, ) -> Result<Controller<B::L>, AUTDError>

Equivalent to Self::open_with_timeout with a timeout of DEFAULT_TIMEOUT.

pub fn open_with_timeout<B: LinkBuilder>( self, link_builder: B, timeout: Duration, ) -> Result<Controller<B::L>, AUTDError>

Opens a controller with a timeout.

Opens link, and then initialize and synchronize the devices. The timeout is used to send data for initialization and synchronization.

Trait Implementations

impl Debug for ControllerBuilder

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

Formats the value using the given formatter.