Struct fuchsia_zircon::HandleRef

pub struct HandleRef<'a> { /* fields omitted */ }

A borrowed reference to a Handle.

Mostly useful as part of a WaitItem.

Methods

impl<'a> HandleRef<'a>

fn raw_handle(&self) -> zx_handle_t

fn duplicate(&self, rights: Rights) -> Result<Handle, Status>

fn signal(&self, clear_mask: Signals, set_mask: Signals) -> Result<(), Status>

fn wait(&self, signals: Signals, deadline: Time) -> Result<Signals, Status>

fn wait_async(
    &self,
    port: &Port,
    key: u64,
    signals: Signals,
    options: WaitAsyncOpts
) -> Result<(), Status>

Trait Implementations

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

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

Formats the value using the given formatter.

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

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> Eq for HandleRef<'a>

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

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

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

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

This method tests for !=.

impl<'a> Hash for HandleRef<'a>

fn hash<__H: Hasher>(&self, __arg_0: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'a> AsHandleRef for HandleRef<'a>

fn as_handle_ref(&self) -> HandleRef

Get a reference to the handle. One important use of such a reference is for object_wait_many.

fn raw_handle(&self) -> zx_handle_t

Interpret the reference as a raw handle (an integer type). Two distinct handles will have different raw values (so it can perhaps be used as a key in a data structure).

fn signal_handle(
    &self,
    clear_mask: Signals,
    set_mask: Signals
) -> Result<(), Status>

Set and clear userspace-accessible signal bits on an object. Wraps the zx_object_signal syscall.

fn wait_handle(
    &self,
    signals: Signals,
    deadline: Time
) -> Result<Signals, Status>

Waits on a handle. Wraps the zx_object_wait_one syscall.

fn wait_async_handle(
    &self,
    port: &Port,
    key: u64,
    signals: Signals,
    options: WaitAsyncOpts
) -> Result<(), Status>

Causes packet delivery on the given port when the object changes state and matches signals. zx_object_wait_async syscall.