Struct Handle

pub struct Handle(/* private fields */);

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

impl Handle

pub const fn invalid() -> Handle

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

pub const unsafe fn from_raw(raw: u32) -> 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.

pub fn is_invalid(&self) -> bool

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

Trait Implementations

impl AsHandleRef for Handle

fn as_handle_ref(&self) -> Unowned<'_, Handle>

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

fn raw_handle(&self) -> u32

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: Instant<MonotonicTimeline>, ) -> WaitResult

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.

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

Get the Property::NAME property for this object.

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

Set the Property::NAME property for this object.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.

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

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

impl Debug for Handle

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

Formats the value using the given formatter.

impl Drop for Handle

fn drop(&mut self)

Executes the destructor for this type.

impl Encodable for Handle

type Encoded = WireHandle

The wire type for the value.

const COPY_OPTIMIZATION: CopyOptimization<Self, Self::Encoded> = _

Whether the conversion from Self to Self::Encoded is equivalent to copying the raw bytes of Self.

impl EncodableOption for Handle

type EncodedOption = WireOptionalHandle

The wire type for the optional value.

impl<E> Encode<E> for Handle

where E: HandleEncoder + ?Sized,

fn encode( self, encoder: &mut E, out: &mut MaybeUninit<<Handle as Encodable>::Encoded>, ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.

impl<E> EncodeOption<E> for Handle

where E: HandleEncoder + ?Sized,

fn encode_option( this: Option<Handle>, encoder: &mut E, out: &mut MaybeUninit<<Handle as EncodableOption>::EncodedOption>, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl From<Bti> for Handle

fn from(x: Bti) -> Handle

Converts to this type from the input type.

impl From<Bti> for Handle

fn from(x: Bti) -> Handle

Converts to this type from the input type.

impl From<Channel> for Handle

fn from(x: Channel) -> Handle

Converts to this type from the input type.

impl<T> From<ClientEnd<T>> for Handle

fn from(client: ClientEnd<T>) -> Handle

Converts to this type from the input type.

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

where Reference: Timeline, Output: Timeline,

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

Converts to this type from the input type.

impl From<Counter> for Handle

fn from(x: Counter) -> Handle

Converts to this type from the input type.

impl From<DebugLog> for Handle

fn from(x: DebugLog) -> Handle

Converts to this type from the input type.

impl From<Event> for Handle

fn from(x: Event) -> Handle

Converts to this type from the input type.

impl From<EventPair> for Handle

fn from(x: EventPair) -> Handle

Converts to this type from the input type.

impl From<Exception> for Handle

fn from(x: Exception) -> Handle

Converts to this type from the input type.

impl From<Exception> for Handle

fn from(x: Exception) -> Handle

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<Guest> for Handle

fn from(x: Guest) -> Handle

Converts to this type from the input type.

impl From<Handle> for Bti

fn from(handle: Handle) -> Bti

Converts to this type from the input type.

impl From<Handle> for Channel

fn from(handle: Handle) -> Channel

Converts to this type from the input type.

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

where Reference: Timeline, Output: Timeline,

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

Converts to this type from the input type.

impl From<Handle> for Counter

fn from(handle: Handle) -> Counter

Converts to this type from the input type.

impl From<Handle> for DebugLog

fn from(handle: Handle) -> DebugLog

Converts to this type from the input type.

impl From<Handle> for Event

fn from(handle: Handle) -> Event

Converts to this type from the input type.

impl From<Handle> for EventPair

fn from(handle: Handle) -> EventPair

Converts to this type from the input type.

impl From<Handle> for Exception

fn from(handle: Handle) -> Exception

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<Handle> for Guest

fn from(handle: Handle) -> Guest

Converts to this type from the input type.

impl From<Handle> for Interrupt

fn from(handle: Handle) -> Interrupt

Converts to this type from the input type.

impl From<Handle> for Iob

fn from(handle: Handle) -> Iob

Converts to this type from the input type.

impl From<Handle> for IobSharedRegion

fn from(handle: Handle) -> IobSharedRegion

Converts to this type from the input type.

impl From<Handle> for Iommu

fn from(handle: Handle) -> Iommu

Converts to this type from the input type.

impl From<Handle> for Job

fn from(handle: Handle) -> Job

Converts to this type from the input type.

impl From<Handle> for Pager

fn from(handle: Handle) -> Pager

Converts to this type from the input type.

impl From<Handle> for Pmt

fn from(handle: Handle) -> Pmt

Converts to this type from the input type.

impl From<Handle> for Port

fn from(handle: Handle) -> Port

Converts to this type from the input type.

impl From<Handle> for Process

fn from(handle: Handle) -> Process

Converts to this type from the input type.

impl From<Handle> for Profile

fn from(handle: Handle) -> Profile

Converts to this type from the input type.

impl From<Handle> for Resource

fn from(handle: Handle) -> Resource

Converts to this type from the input type.

impl From<Handle> for Socket

fn from(handle: Handle) -> Socket

Converts to this type from the input type.

impl From<Handle> for Stream

fn from(handle: Handle) -> Stream

Converts to this type from the input type.

impl From<Handle> for Thread

fn from(handle: Handle) -> Thread

Converts to this type from the input type.

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

where T: Timeline,

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

Converts to this type from the input type.

impl From<Handle> for Vcpu

fn from(handle: Handle) -> Vcpu

Converts to this type from the input type.

impl From<Handle> for Vmar

fn from(handle: Handle) -> Vmar

Converts to this type from the input type.

impl From<Handle> for Vmo

fn from(handle: Handle) -> Vmo

Converts to this type from the input type.

impl From<Interrupt> for Handle

fn from(x: Interrupt) -> Handle

Converts to this type from the input type.

impl From<Iob> for Handle

fn from(x: Iob) -> Handle

Converts to this type from the input type.

impl From<IobSharedRegion> for Handle

fn from(x: IobSharedRegion) -> Handle

Converts to this type from the input type.

impl From<Iommu> for Handle

fn from(x: Iommu) -> Handle

Converts to this type from the input type.

impl From<Iommu> for Handle

fn from(x: Iommu) -> Handle

Converts to this type from the input type.

impl From<Job> for Handle

fn from(x: Job) -> Handle

Converts to this type from the input type.

impl From<Msi> for Handle

fn from(x: Msi) -> Handle

Converts to this type from the input type.

impl From<Pager> for Handle

fn from(x: Pager) -> Handle

Converts to this type from the input type.

impl From<Pager> for Handle

fn from(x: Pager) -> Handle

Converts to this type from the input type.

impl From<PciDevice> for Handle

fn from(x: PciDevice) -> Handle

Converts to this type from the input type.

impl From<Pmt> for Handle

fn from(x: Pmt) -> Handle

Converts to this type from the input type.

impl From<Pmt> for Handle

fn from(x: Pmt) -> Handle

Converts to this type from the input type.

impl From<Port> for Handle

fn from(x: Port) -> Handle

Converts to this type from the input type.

impl From<Process> for Handle

fn from(x: Process) -> Handle

Converts to this type from the input type.

impl From<Profile> for Handle

fn from(x: Profile) -> Handle

Converts to this type from the input type.

impl From<Resource> for Handle

fn from(x: Resource) -> Handle

Converts to this type from the input type.

impl<T> From<ServerEnd<T>> for Handle

fn from(server: ServerEnd<T>) -> Handle

Converts to this type from the input type.

impl From<Socket> for Handle

fn from(x: Socket) -> Handle

Converts to this type from the input type.

impl From<Stream> for Handle

fn from(x: Stream) -> Handle

Converts to this type from the input type.

impl From<SuspendToken> for Handle

fn from(x: SuspendToken) -> Handle

Converts to this type from the input type.

impl From<Thread> for Handle

fn from(x: Thread) -> Handle

Converts to this type from the input type.

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

where T: Timeline,

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

Converts to this type from the input type.

impl From<Vcpu> for Handle

fn from(x: Vcpu) -> Handle

Converts to this type from the input type.

impl From<Vmar> for Handle

fn from(x: Vmar) -> Handle

Converts to this type from the input type.

impl From<Vmo> for Handle

fn from(x: Vmo) -> Handle

Converts to this type from the input type.

impl FromWire<WireHandle> for Handle

fn from_wire(wire: WireHandle) -> Handle

Converts the given wire to this type.

const COPY_OPTIMIZATION: CopyOptimization<W, Self> = _

Whether the conversion from W to Self is equivalent to copying the raw bytes of W.

impl FromWireOption<WireOptionalHandle> for Handle

fn from_wire_option(wire: WireOptionalHandle) -> Option<Handle>

Converts the given wire to an option of this type.

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) -> u32

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>(self) -> H

where H: HandleBased,

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

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

where H: HandleBased,

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

fn is_invalid_handle(&self) -> bool

impl HandleFor<DefaultFuchsiaResourceDialect> for Handle

type HandleInfo = HandleInfo

Handle info used in this dialect.

fn invalid() -> Handle

Produce an invalid version of Handle used as a place filler when we remove handles from an array.

fn is_invalid(&self) -> bool

Check whether a handle is invalid.

impl Hash for Handle

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Handle

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Handle

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Handle

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Handle

impl StructuralPartialEq for Handle