Struct async_io::parking::Parker

pub struct Parker { /* fields omitted */ }

Waits for a notification.

Implementations

impl Parker

pub fn new() -> Parker

Creates a new parker.

Examples

use async_io::parking::Parker;

let p = Parker::new();

pub fn park(&self)

Blocks until notified and then goes back into unnotified state.

Examples

use async_io::parking::Parker;

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

// Notify the parker.
u.unpark();

// Wakes up immediately because the parker is notified.
p.park();

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

Blocks until notified and then goes back into unnotified state, or times out after duration.

Returns true if notified before the timeout.

Examples

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

let p = Parker::new();

// Wait for a notification, or time out after 500 ms.
p.park_timeout(Duration::from_millis(500));

pub fn park_deadline(&self, deadline: Instant) -> bool

Blocks until notified and then goes back into unnotified state, or times out at instant.

Returns true if notified before the deadline.

Examples

use async_io::parking::Parker;
use std::time::{Duration, Instant};

let p = Parker::new();

// Wait for a notification, or time out after 500 ms.
p.park_deadline(Instant::now() + Duration::from_millis(500));

pub fn unpark(&self)

Notifies the parker.

Examples

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

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 unparker(&self) -> Unparker

Returns a handle for unparking.

The returned Unparker can be cloned and shared among threads.

Examples

use async_io::parking::Parker;

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

// Notify the parker.
u.unpark();

// Wakes up immediately because the parker is notified.
p.park();

Trait Implementations

impl Debug for Parker

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

Formats the value using the given formatter.

impl Default for Parker

fn default() -> Parker

Returns the "default value" for a type.

impl Drop for Parker

fn drop(&mut self)

Executes the destructor for this type.