Struct maitake::sync::semaphore::Acquire

pub struct Acquire<'sem, Lock = Spinlock>
where
    Lock: RawMutex,
{ /* private fields */ }

The future returned by the Semaphore::acquire method.

Notes

This future is !Unpin, as it is unsafe to core::mem::forget an Acquire future once it has been polled. For instance, the following code must not compile:

 use maitake_sync::semaphore::Acquire;

 // Calls to this function should only compile if `T` is `Unpin`.
 fn assert_unpin<T: Unpin>() {}

 assert_unpin::<Acquire<'_>>();

Trait Implementations

impl<'sem, Lock> Debug for Acquire<'sem, Lock>

where Lock: Debug + RawMutex,

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

Formats the value using the given formatter.

impl<'sem, Lock> Drop for Acquire<'sem, Lock>

where Lock: RawMutex,

fn drop(&mut self)

Executes the destructor for this type.

impl<'sem, Lock> Future for Acquire<'sem, Lock>

where Lock: RawMutex,

type Output = Result<Permit<'sem, Lock>, Closed>

The type of value produced on completion.

fn poll( self: Pin<&mut Acquire<'sem, Lock>>, cx: &mut Context<'_> ) -> Poll<<Acquire<'sem, Lock> as Future>::Output>

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

impl<Lock> Sync for Acquire<'_, Lock>

where Lock: RawMutex,

impl<'pin, 'sem, Lock> Unpin for Acquire<'sem, Lock>

where Lock: RawMutex, __Acquire<'pin, 'sem, Lock>: Unpin,