Struct halt::Remote

pub struct Remote { /* fields omitted */ }

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

Examples

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

Methods

impl Remote

pub fn pause(&self) -> Result

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

pub fn resume(&self) -> Result

Resumes the iterator, causing the Halt wrapper to run as normal.

pub fn stop(&self) -> Result

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

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

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.