[−][src]Struct halt::Remote
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 pause(&self)
[src]
Pauses the Halt
, causing the thread that runs it to sleep until resumed or stopped.
Panics
Panics if the Halt
has been dropped.
pub fn resume(&self)
[src]
pub fn stop(&self)
[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)
.
Panics
Panics if the Halt
has been dropped.
pub fn is_paused(&self) -> bool
[src]
Returns true
if paused.
pub fn is_running(&self) -> bool
[src]
Returns true
if running.
pub fn is_stopped(&self) -> bool
[src]
Returns true
if stopped.
pub fn is_valid(&self) -> bool
[src]
Returns true
if the Remote
is valid, i.e. the Halt
has not been dropped.
Trait Implementations
Auto Trait Implementations
impl Send for Remote
impl Sync for Remote
impl Unpin for Remote
impl !UnwindSafe for Remote
impl !RefUnwindSafe for Remote
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = !
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,