Struct blocking_permit::SyncBlockingPermitFuture

#[must_use = "futures do nothing unless awaited or polled"]
pub struct SyncBlockingPermitFuture<'a> { /* fields omitted */ }

A Sync wrapper available via BlockingPermitFuture::make_sync.

Methods

impl<'a> SyncBlockingPermitFuture<'a>

Important traits for SyncBlockingPermitFuture<'a>

impl<'a> Future for SyncBlockingPermitFuture<'a> type Output = Result<BlockingPermit<'a>, Canceled>;

pub fn new(semaphore: &'a Semaphore) -> SyncBlockingPermitFuture<'a>

Construct given Semaphore reference.

Trait Implementations

impl<'a> Debug for SyncBlockingPermitFuture<'a>

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

Formats the value using the given formatter.

impl<'a> Future for SyncBlockingPermitFuture<'a>

type Output = Result<BlockingPermit<'a>, Canceled>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.