Struct halt::Remote

pub struct Remote { /* private fields */ }

A remote that allows for pausing, stopping, and resuming the Halt wrapper from another thread.

Examples

let halt = halt::new(0..10);
let remote = halt.remote();

Implementations

impl Remote

pub fn resume(&self) -> bool

Resumes the Halt, causing it to run as normal.

Returns true if the remote is_valid.

pub fn pause(&self) -> bool

Pauses the Halt, causing the thread that runs it to sleep until resumed or stopped.

Returns true if the remote is_valid.

pub fn stop(&self) -> bool

Stops the Halt, causing it to behave as done until resumed or paused.

When Halt is used as an iterator, the iterator will return None. When used as a reader or writer, it will return Ok(0).

Returns true if the remote is_valid.

pub fn is_valid(&self) -> bool

Returns true if the remote is valid, i.e. the Halt has not been dropped.

pub fn is_running(&self) -> bool

Returns true if running.

pub fn is_paused(&self) -> bool

Returns true if paused.

pub fn is_stopped(&self) -> bool

Returns true if stopped.

Trait Implementations

impl Clone for Remote

fn clone(&self) -> Remote

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Remote

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

Formats the value using the given formatter.