Struct Unparker

pub struct Unparker { /* private fields */ }

Notifies a parker.

Implementations

impl Unparker

pub fn unpark(&self) -> bool

Notifies the associated parker.

Returns true if this call is the first to notify the parker, or false if the parker was already notified.

Examples

use std::thread;
use std::time::Duration;
use parking::Parker;

let p = Parker::new();
let u = p.unparker();

thread::spawn(move || {
    thread::sleep(Duration::from_millis(500));
    u.unpark();
});

// Wakes up when `u.unpark()` notifies and then goes back into unnotified state.
p.park();

pub fn will_unpark(&self, parker: &Parker) -> bool

Indicates whether this unparker will unpark the associated parker.

This can be used to avoid unnecessary work before calling unpark().

Examples

use parking::Parker;

let p = Parker::new();
let u = p.unparker();

assert!(u.will_unpark(&p));

pub fn same_parker(&self, other: &Unparker) -> bool

Indicates whether two unparkers will unpark the same parker.

Examples

use parking::Parker;

let p = Parker::new();
let u1 = p.unparker();
let u2 = p.unparker();

assert!(u1.same_parker(&u2));

Trait Implementations

impl Clone for Unparker

fn clone(&self) -> Unparker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Unparker

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

Formats the value using the given formatter.

impl From<Unparker> for Waker

fn from(up: Unparker) -> Self

Converts to this type from the input type.