Struct futures_turnstyle::Turnstyle

pub struct Turnstyle { /* fields omitted */ }

An ordered queue of waiting participants.

Every turn of the turnstyle, the next participant in queue is notified and removed from the queue. If the queue is empty, turn is a noop.

Turnstyles can be cloned and are safe to share across threads.

Methods

impl Turnstyle

pub fn new() -> Turnstyle

Creates a new, empty turnstyle.

pub fn join(&self) -> Waiter

Joins the waiting queue.

Returns a Waiter to the caller, which will complete when the turnstyle turns and reaches the caller's position in the queue.

pub fn turn(&self)

Turns once, letting a single waiter through.

The Waiter is notified by the future completing.

Trait Implementations

impl Clone for Turnstyle

fn clone(&self) -> Turnstyle

Returns a copy of the value.

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

Performs copy-assignment from source.