Struct WaitOwned

pub struct WaitOwned<K, V, Lock = DefaultMutex>
where
    K: PartialEq,
    Lock: ScopedRawMutex,
{ /* private fields */ }

Future returned from WaitMap::wait_owned().

This is identical to the Wait future, except that it takes an Arc reference to the WaitMap, allowing the returned future to live for the 'static lifetime.

This future is fused, so once it has completed, any future calls to poll will immediately return Poll::Ready.

Notes

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

 use maitake_sync::wait_map::WaitOwned;

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

 assert_unpin::<WaitOwned<'_, usize, ()>>();

Trait Implementations

impl<K, V, Lock> Debug for WaitOwned<K, V, Lock>

where K: Debug + PartialEq, V: Debug, Lock: Debug + ScopedRawMutex,

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

Formats the value using the given formatter.

impl<K, V, Lock> Drop for WaitOwned<K, V, Lock>

where K: PartialEq, Lock: ScopedRawMutex,

fn drop(&mut self)

Executes the destructor for this type.

impl<K, V, Lock> Future for WaitOwned<K, V, Lock>

where K: PartialEq, Lock: ScopedRawMutex,

type Output = Result<V, WaitError>

The type of value produced on completion.

fn poll( self: Pin<&mut WaitOwned<K, V, Lock>>, cx: &mut Context<'_>, ) -> Poll<<WaitOwned<K, V, 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<'pin, K, V, Lock> Unpin for WaitOwned<K, V, Lock>

where K: PartialEq, Lock: ScopedRawMutex, <PinnedFieldsOfHelperStruct<__WaitOwned<'pin, K, V, Lock>> as PinnedFieldsOfHelperTrait>::Actual: Unpin,