Struct SpinOptions

#[non_exhaustive]
pub struct SpinOptions {
    pub only_next_available_work: bool,
    pub timeout: Option<Duration>,
}

A bundle of optional conditions that a user may want to impose on how long an executor spins for.

By default the executor will be allowed to spin indefinitely.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

only_next_available_work: bool

Only perform the next available work. This is similar to spin_once in rclcpp and rclpy.

To only process work that is immediately available without waiting at all, set a timeout of zero.

timeout: Option<Duration>

Stop waiting after this duration of time has passed. Use Some(0) to not wait any amount of time. Use None to wait an infinite amount of time.

Implementations

impl SpinOptions

pub fn new() -> Self

Use default spin options.

pub fn spin_once() -> Self

Behave like spin_once in rclcpp and rclpy.

pub fn timeout(self, timeout: Duration) -> Self

Stop spinning once this durtion of time is reached.

Trait Implementations

impl Default for SpinOptions

fn default() -> SpinOptions

Returns the “default value” for a type.