Struct AcquireOwned

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

Future returned from Semaphore::acquire_owned().

This is identical to the Acquire future, except that it takes an Arc reference to the Semaphore, allowing the returned future to live for the 'static lifetime, and returns an OwnedPermit (rather than a Permit), which is also valid for the 'static lifetime.

Notes

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

 use maitake_sync::semaphore::AcquireOwned;

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

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

Trait Implementations

impl<Lock> Debug for AcquireOwned<Lock>

where Lock: Debug + RawMutex,

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

Formats the value using the given formatter.

impl<Lock> Drop for AcquireOwned<Lock>

where Lock: RawMutex,

fn drop(&mut self)

Executes the destructor for this type.

impl<Lock> Future for AcquireOwned<Lock>

where Lock: RawMutex,

type Output = Result<OwnedPermit<Lock>, Closed>

The type of value produced on completion.

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

Attempts 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 AcquireOwned<Lock>

where Lock: RawMutex,

impl<'pin, Lock> Unpin for AcquireOwned<Lock>

where Lock: RawMutex, <PinnedFieldsOfHelperStruct<__AcquireOwned<'pin, Lock>> as PinnedFieldsOfHelperTrait>::Actual: Unpin,