Struct tokio_executor::park::ParkThread

pub struct ParkThread { /* fields omitted */ }

Blocks the current thread using a condition variable.

Implements the Park functionality by using a condition variable. An atomic variable is also used to avoid using the condition variable if possible.

The condition variable is cached in a thread-local variable and is shared across all ParkThread instances created on the same thread. This also means that an instance of ParkThread might be unblocked by a handle associated with a different ParkThread instance.

Implementations

impl ParkThread

pub fn new() -> ParkThread

Create a new ParkThread handle for the current thread.

This type cannot be moved to other threads, so it should be created on the thread that the caller intends to park.

Trait Implementations

impl Debug for ParkThread

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

Formats the value using the given formatter.

impl Default for ParkThread

fn default() -> Self

Returns the “default value” for a type.

impl Park for ParkThread

type Unpark = UnparkThread

Unpark handle type for the Park implementation.

type Error = ParkError

Error returned by park

fn unpark(&self) -> Self::Unpark

Get a new Unpark handle associated with this Park instance.

fn park(&mut self) -> Result<(), Self::Error>

Block the current thread unless or until the token is available.

fn park_timeout(&mut self, duration: Duration) -> Result<(), Self::Error>

Park the current thread for at most duration.