[][src]Struct halt::Remote

pub struct Remote { /* fields omitted */ }

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();

Methods

impl Remote[src]

pub fn resume(&self) -> bool[src]

Resumes the Halt, causing it to run as normal.

Returns true if the remote is_valid.

pub fn pause(&self) -> bool[src]

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[src]

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[src]

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

pub fn is_running(&self) -> bool[src]

Returns true if running.

pub fn is_paused(&self) -> bool[src]

Returns true if paused.

pub fn is_stopped(&self) -> bool[src]

Returns true if stopped.

Trait Implementations

impl Clone for Remote[src]

impl Debug for Remote[src]

Auto Trait Implementations

impl !RefUnwindSafe for Remote

impl Send for Remote

impl Sync for Remote

impl Unpin for Remote

impl !UnwindSafe for Remote

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.