Struct PollSemaphore

impl PollSemaphore

fn new(semaphore: Arc<Semaphore>) -> Self

Create a new PollSemaphore.

fn close(&self)

Closes the semaphore.

fn clone_inner(&self) -> Arc<Semaphore>

Obtain a clone of the inner semaphore.

fn into_inner(self) -> Arc<Semaphore>

Get back the inner semaphore.

fn poll_acquire(&mut self, cx: &mut Context<'_>) -> Poll<Option<OwnedSemaphorePermit>>

Poll to acquire a permit from the semaphore.

This can return the following values:

• Poll::Pending if a permit is not currently available.
• Poll::Ready(Some(permit)) if a permit was acquired.
• Poll::Ready(None) if the semaphore has been closed.

When this method returns Poll::Pending, the current task is scheduled to receive a wakeup when a permit becomes available, or when the semaphore is closed. Note that on multiple calls to poll_acquire, only the Waker from the Context passed to the most recent call is scheduled to receive a wakeup.

fn poll_acquire_many(&mut self, cx: &mut Context<'_>, permits: u32) -> Poll<Option<OwnedSemaphorePermit>>

Poll to acquire many permits from the semaphore.

This can return the following values:

• Poll::Pending if a permit is not currently available.
• Poll::Ready(Some(permit)) if a permit was acquired.
• Poll::Ready(None) if the semaphore has been closed.

When this method returns Poll::Pending, the current task is scheduled to receive a wakeup when the permits become available, or when the semaphore is closed. Note that on multiple calls to poll_acquire, only the Waker from the Context passed to the most recent call is scheduled to receive a wakeup.

fn available_permits(&self) -> usize

Returns the current number of available permits.

This is equivalent to the Semaphore::available_permits method on the tokio::sync::Semaphore type.

fn add_permits(&self, n: usize)

Adds n new permits to the semaphore.

The maximum number of permits is Semaphore::MAX_PERMITS, and this function will panic if the limit is exceeded.

This is equivalent to the Semaphore::add_permits method on the tokio::sync::Semaphore type.