Struct Waker 

pub struct Waker(/* private fields */);

Ends a Backend::read under way early, from any thread: a value made on another thread is then picked up at once, rather than when the read’s timeout runs out. Clones wake the same reads. A wake that comes while no read is under way ends the next one at once, so none is lost; a read woken returns None, as if its timeout had passed.

Session waits on it with the terminal (a self-pipe beside the terminal in one poll, on Unix; elsewhere it looks between short waits). Any other backend, or a loop of one’s own, can wait on it with wait.

use rich_interact::Waker;
use std::time::Duration;

let waker = Waker::new();
let other = waker.clone();
std::thread::spawn(move || other.wake());
assert!(waker.wait(Duration::from_secs(5)));
// Taken: the next wait waits.
assert!(!waker.wait(Duration::from_millis(1)));

Implementations

impl Waker

pub fn new() -> Waker

pub fn wake(&self)

End the read under way, or the next one.

pub fn take(&self) -> bool

Whether it was woken since the last call (or wait); it is not woken after.

pub fn wait(&self, timeout: Duration) -> bool

Wait until woken, timeout at most; whether it was (and it is not woken after).

Trait Implementations

impl Clone for Waker

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Waker

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

Formats the value using the given formatter.

impl Default for Waker

fn default() -> Waker

Returns the “default value” for a type.