Struct SpinOptions 

pub struct SpinOptions {
    pub timeout: Option<Duration>,
    pub only_next: bool,
    pub max_callbacks: Option<usize>,
}

Options controlling blocking spin behavior.

Used with Executor::spin_blocking to control when the spin loop exits.

Fields

timeout: Option<Duration>

Stop after this duration.

phase-379 W5 — a Duration, not a u64 of milliseconds. The _ms suffix was inconsistent with the two methods that consume these options (Executor::spin_once and Executor::spin already take core::time::Duration) as well as with rclrs’s SpinOptions::timeout. Milliseconds ARE the unit the platform ABI’s wait primitives take, but that conversion belongs at the ABI boundary, where it already happens — not in the public option a user writes.

only_next: bool

Only process immediately available work (single iteration)

max_callbacks: Option<usize>

Stop after processing this many callbacks total

Implementations

impl SpinOptions

pub const fn new() -> SpinOptions

Create default spin options (spin forever until halted)

pub const fn timeout(self, timeout: Duration) -> SpinOptions

Set a timeout duration.

Matches rclrs’s SpinOptions::timeout(Duration). Stays const — ours is a strict superset there, and Duration::from_millis is const-stable well below this workspace’s MSRV, so SpinOptions::new().timeout( Duration::from_millis(50)) is usable in a const context.

pub const fn spin_once() -> SpinOptions

Only process one round of work (equivalent to spin_once)

pub const fn max_callbacks(self, n: usize) -> SpinOptions

Stop after processing N callbacks

Trait Implementations

impl Clone for SpinOptions

fn clone(&self) -> SpinOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpinOptions

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

Formats the value using the given formatter.

impl Default for SpinOptions

fn default() -> SpinOptions

Returns the “default value” for a type.