Struct Parker 

pub struct Parker { /* private fields */ }

Waits for a notification.

Implementations

impl Parker

pub fn new() -> Parker

Creates a new parker.

Examples

use parking::Parker;

let p = Parker::new();

pub fn park(&self)

Blocks until notified and then goes back into unnotified state.

Examples

use 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, duration: 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 std::time::Duration;
use parking::Parker;

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, instant: 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 std::time::{Duration, Instant};
use parking::Parker;

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) -> bool

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

assert_eq!(p.unpark(), true);
assert_eq!(p.unpark(), false);

// Wakes up immediately.
p.park();

pub fn unparker(&self) -> Unparker

Returns a handle for unparking.

The returned Unparker can be cloned and shared among threads.

Examples

use 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.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes