Struct zx::Handle

source ·
pub struct Handle(/* private fields */);
Expand description

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.

Implementations§

source§

impl Handle

source

pub const fn invalid() -> Handle

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

source

pub const 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.

§Safety

raw must either be a valid handle (i.e. not dangling), or ZX_HANDLE_INVALID. If raw is a valid handle, then either:

  • raw may be closed manually and the returned Handle must not be dropped.
  • Or raw must not be closed until the returned Handle is dropped, at which time it will close raw.
source

pub fn is_invalid(&self) -> bool

source

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

Trait Implementations§

source§

impl AsHandleRef for Handle

source§

fn as_handle_ref(&self) -> HandleRef<'_>

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

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).
source§

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.
source§

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

Waits on a handle. Wraps the zx_object_wait_one syscall.
source§

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.
source§

fn get_name(&self) -> Result<Name, Status>

Get the Property::NAME property for this object. Read more
source§

fn set_name(&self, name: &Name) -> Result<(), Status>

Set the Property::NAME property for this object. Read more
source§

fn basic_info(&self) -> Result<HandleBasicInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.
source§

fn count_info(&self) -> Result<HandleCountInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.
source§

fn get_koid(&self) -> Result<Koid, Status>

Returns the koid (kernel object ID) for this handle.
source§

impl Debug for Handle

source§

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

Formats the value using the given formatter. Read more
source§

impl Drop for Handle

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl From<Bti> for Handle

source§

fn from(x: Bti) -> Handle

Converts to this type from the input type.
source§

impl From<Channel> for Handle

source§

fn from(x: Channel) -> Handle

Converts to this type from the input type.
source§

impl<Reference: Timeline, Output: Timeline> From<Clock<Reference, Output>> for Handle

source§

fn from(x: Clock<Reference, Output>) -> Handle

Converts to this type from the input type.
source§

impl From<DebugLog> for Handle

source§

fn from(x: DebugLog) -> Handle

Converts to this type from the input type.
source§

impl From<Event> for Handle

source§

fn from(x: Event) -> Handle

Converts to this type from the input type.
source§

impl From<EventPair> for Handle

source§

fn from(x: EventPair) -> Handle

Converts to this type from the input type.
source§

impl From<Exception> for Handle

source§

fn from(x: Exception) -> Handle

Converts to this type from the input type.
source§

impl<R, W> From<Fifo<R, W>> for Handle

source§

fn from(x: Fifo<R, W>) -> Handle

Converts to this type from the input type.
source§

impl From<Guest> for Handle

source§

fn from(x: Guest) -> Handle

Converts to this type from the input type.
source§

impl From<Handle> for Bti

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Channel

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl<Reference: Timeline, Output: Timeline> From<Handle> for Clock<Reference, Output>

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for DebugLog

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Event

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for EventPair

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Exception

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl<R, W> From<Handle> for Fifo<R, W>

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Guest

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Interrupt

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Iommu

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Job

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Pager

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Pmt

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Port

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Process

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Profile

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Resource

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Socket

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Stream

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Thread

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl<T: Timeline> From<Handle> for Timer<T>

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Vcpu

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Vmar

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Handle> for Vmo

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Interrupt> for Handle

source§

fn from(x: Interrupt) -> Handle

Converts to this type from the input type.
source§

impl From<Iommu> for Handle

source§

fn from(x: Iommu) -> Handle

Converts to this type from the input type.
source§

impl From<Job> for Handle

source§

fn from(x: Job) -> Handle

Converts to this type from the input type.
source§

impl From<Pager> for Handle

source§

fn from(x: Pager) -> Handle

Converts to this type from the input type.
source§

impl From<Pmt> for Handle

source§

fn from(x: Pmt) -> Handle

Converts to this type from the input type.
source§

impl From<Port> for Handle

source§

fn from(x: Port) -> Handle

Converts to this type from the input type.
source§

impl From<Process> for Handle

source§

fn from(x: Process) -> Handle

Converts to this type from the input type.
source§

impl From<Profile> for Handle

source§

fn from(x: Profile) -> Handle

Converts to this type from the input type.
source§

impl From<Resource> for Handle

source§

fn from(x: Resource) -> Handle

Converts to this type from the input type.
source§

impl From<Socket> for Handle

source§

fn from(x: Socket) -> Handle

Converts to this type from the input type.
source§

impl From<Stream> for Handle

source§

fn from(x: Stream) -> Handle

Converts to this type from the input type.
source§

impl From<Thread> for Handle

source§

fn from(x: Thread) -> Handle

Converts to this type from the input type.
source§

impl<T: Timeline> From<Timer<T>> for Handle

source§

fn from(x: Timer<T>) -> Handle

Converts to this type from the input type.
source§

impl From<Vcpu> for Handle

source§

fn from(x: Vcpu) -> Handle

Converts to this type from the input type.
source§

impl From<Vmar> for Handle

source§

fn from(x: Vmar) -> Handle

Converts to this type from the input type.
source§

impl From<Vmo> for Handle

source§

fn from(x: Vmo) -> Handle

Converts to this type from the input type.
source§

impl HandleBased for Handle

source§

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

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

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.
source§

fn into_handle(self) -> Handle

Converts the value into its inner handle. Read more
source§

fn into_raw(self) -> zx_handle_t

Converts the handle into it’s raw representation. Read more
source§

fn from_handle(handle: Handle) -> Self

Creates an instance of this type from a handle. Read more
source§

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

Creates an instance of another handle-based type from this value’s inner handle.
source§

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

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

fn is_invalid_handle(&self) -> bool

source§

impl Hash for Handle

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Handle

source§

fn cmp(&self, other: &Handle) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Handle

source§

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for Handle

source§

fn partial_cmp(&self, other: &Handle) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Eq for Handle

source§

impl StructuralPartialEq for Handle

Auto Trait Implementations§

§

impl Freeze for Handle

§

impl RefUnwindSafe for Handle

§

impl Send for Handle

§

impl Sync for Handle

§

impl Unpin for Handle

§

impl UnwindSafe for Handle

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.