Struct fuchsia_zircon::Handle

pub struct Handle(_);

An object representing a Zircon handle.

Internally, it is represented as a 32-bit integer, but this wrapper enforces strict ownership semantics. The Drop implementation closes the handle.

This type represents the most general reference to a kernel object, and can be interconverted to and from more specific types. Those conversions are not enforced in the type system; attempting to use them will result in errors returned by the kernel. These conversions don't change the underlying representation, but do change the type and thus what operations are available.

Methods

impl Handle

fn invalid() -> Handle

Initialize a handle backed by ZX_HANDLE_INVALID, the only safe non-handle.

unsafe fn from_raw(raw: zx_handle_t) -> Handle

If a raw handle is obtained from some other source, this method converts it into a type-safe owned handle.

fn is_invalid(&self) -> bool

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

Trait Implementations

impl From<Channel> for Handle

fn from(x: Channel) -> Handle

Performs the conversion.

impl From<Event> for Handle

fn from(x: Event) -> Handle

Performs the conversion.

impl From<EventPair> for Handle

fn from(x: EventPair) -> Handle

Performs the conversion.

impl From<Fifo> for Handle

fn from(x: Fifo) -> Handle

Performs the conversion.

impl Debug for Handle

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

Formats the value using the given formatter.

impl Eq for Handle

impl PartialEq for Handle

fn eq(&self, __arg_0: &Handle) -> bool

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

fn ne(&self, __arg_0: &Handle) -> bool

This method tests for !=.

impl Hash for Handle

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 AsHandleRef for Handle

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.

impl HandleBased for Handle

fn duplicate_handle(&self, rights: Rights) -> Result<Self, Status>

Duplicate a handle, possibly reducing the rights available. Wraps the zx_handle_duplicate syscall.

fn replace_handle(self, rights: Rights) -> Result<Self, Status>

Create a replacement for a handle, possibly reducing the rights available. This invalidates the original handle. Wraps the zx_handle_replace syscall.

fn into_handle(self) -> Handle

Converts the value into its inner handle.

fn into_raw(self) -> zx_handle_t

Converts the handle into it's raw representation.

fn from_handle(handle: Handle) -> Self

Creates an instance of this type from a handle.

fn into_handle_based<H: HandleBased>(self) -> H

Creates an instance of another handle-based type from this value's inner handle.

fn from_handle_based<H: HandleBased>(h: H) -> Self

Creates an instance of this type from the inner handle of another handle-based type.

impl Drop for Handle

fn drop(&mut self)

Executes the destructor for this type.

impl From<Job> for Handle

fn from(x: Job) -> Handle

Performs the conversion.

impl From<Port> for Handle

fn from(x: Port) -> Handle

Performs the conversion.

impl From<Process> for Handle

fn from(x: Process) -> Handle

Performs the conversion.

impl From<Socket> for Handle

fn from(x: Socket) -> Handle

Performs the conversion.

impl From<Timer> for Handle

fn from(x: Timer) -> Handle

Performs the conversion.

impl From<Thread> for Handle

fn from(x: Thread) -> Handle

Performs the conversion.

impl From<Vmo> for Handle

fn from(x: Vmo) -> Handle

Performs the conversion.