Struct sunrise_libuser::types::HandleRef

#[repr(transparent)]pub struct HandleRef<'a> {
    pub(crate) inner: NonZeroU32,
    lifetime: PhantomData<&'a Handle>,
}

A fake reference to a Handle. Has the same representation as a real Handle, but is bound to the real handle's lifetime.

This pattern allows for passing handle arrays without giving up ownership of the handle, and without an expensive conversion from an array of pointers to an array of handles.

Fields

inner: NonZeroU32

The underlying handle number.

lifetime: PhantomData<&'a Handle>

The real handle this reference is tied to.

Implementations

impl<'a> HandleRef<'a>

pub fn staticify(self) -> HandleRef<'static>

Remove the lifetime on the current HandleRef. See Handle::as_ref_static() for more information on the safety of this operation.

pub fn wait_async(
    self,
    queue: WorkQueue
) -> impl Future<Output = Result<(), Error>> + Unpin

Returns a future that waits for the current handle to get signaled. This effectively registers the currently executing Task to be polled again by the future executor backing the given WorkQueue when this handle gets signaled.

Panics

Panics if used from outside the context of a Future spawned on a libuser future executor. Please make sure you only call this function from a future spawned on a WaitableManager.

Trait Implementations

impl<'a> Clone for HandleRef<'a>

fn clone(&self) -> HandleRef<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for HandleRef<'a>

impl<'a> Debug for HandleRef<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for HandleRef<'a>

impl<'a> PartialEq<HandleRef<'a>> for HandleRef<'a>

fn eq(&self, other: &HandleRef<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HandleRef<'a>) -> bool

This method tests for !=.

impl<'a> StructuralEq for HandleRef<'a>

impl<'a> StructuralPartialEq for HandleRef<'a>