Struct ZirconHandle 

pub struct ZirconHandle(/* 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 NullableHandle

pub const fn invalid() -> NullableHandle

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

pub const unsafe fn from_raw(raw: u32) -> NullableHandle

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 NullableHandle must not be dropped.
• Or raw must not be closed until the returned NullableHandle is dropped, at which time it will close raw.

pub const fn raw_handle(&self) -> u32

pub fn into_raw(self) -> u32

pub const fn is_invalid(&self) -> bool

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

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

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

pub fn wait_one( &self, signals: Signals, deadline: Instant<MonotonicTimeline>, ) -> WaitResult

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

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

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

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

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

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

Trait Implementations

impl AsHandleRef for NullableHandle

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

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 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 NullableHandle

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

Formats the value using the given formatter.

impl From<Bti> for NullableHandle

fn from(x: Bti) -> NullableHandle

Converts to this type from the input type.

impl From<Channel> for NullableHandle

fn from(x: Channel) -> NullableHandle

Converts to this type from the input type.

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

where Reference: Timeline, Output: Timeline,

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

Converts to this type from the input type.

impl From<Counter> for NullableHandle

fn from(x: Counter) -> NullableHandle

Converts to this type from the input type.

impl From<DebugLog> for NullableHandle

fn from(x: DebugLog) -> NullableHandle

Converts to this type from the input type.

impl From<Event> for NullableHandle

fn from(x: Event) -> NullableHandle

Converts to this type from the input type.

impl From<EventPair> for NullableHandle

fn from(x: EventPair) -> NullableHandle

Converts to this type from the input type.

impl From<Exception> for NullableHandle

fn from(x: Exception) -> NullableHandle

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<Guest> for NullableHandle

fn from(x: Guest) -> NullableHandle

Converts to this type from the input type.

impl<K, T> From<Interrupt<K, T>> for NullableHandle

where K: InterruptKind, T: Timeline,

fn from(x: Interrupt<K, T>) -> NullableHandle

Converts to this type from the input type.

impl From<Iob> for NullableHandle

fn from(x: Iob) -> NullableHandle

Converts to this type from the input type.

impl From<IobSharedRegion> for NullableHandle

fn from(x: IobSharedRegion) -> NullableHandle

Converts to this type from the input type.

impl From<Iommu> for NullableHandle

fn from(x: Iommu) -> NullableHandle

Converts to this type from the input type.

impl From<Job> for NullableHandle

fn from(x: Job) -> NullableHandle

Converts to this type from the input type.

impl From<Pager> for NullableHandle

fn from(x: Pager) -> NullableHandle

Converts to this type from the input type.

impl From<Pmt> for NullableHandle

fn from(x: Pmt) -> NullableHandle

Converts to this type from the input type.

impl From<Port> for NullableHandle

fn from(x: Port) -> NullableHandle

Converts to this type from the input type.

impl From<Process> for NullableHandle

fn from(x: Process) -> NullableHandle

Converts to this type from the input type.

impl From<Profile> for NullableHandle

fn from(x: Profile) -> NullableHandle

Converts to this type from the input type.

impl From<Resource> for NullableHandle

fn from(x: Resource) -> NullableHandle

Converts to this type from the input type.

impl From<Socket> for NullableHandle

fn from(x: Socket) -> NullableHandle

Converts to this type from the input type.

impl From<Stream> for NullableHandle

fn from(x: Stream) -> NullableHandle

Converts to this type from the input type.

impl From<Thread> for NullableHandle

fn from(x: Thread) -> NullableHandle

Converts to this type from the input type.

impl<T> From<Timer<T>> for NullableHandle

where T: Timeline,

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

Converts to this type from the input type.

impl From<Vcpu> for NullableHandle

fn from(x: Vcpu) -> NullableHandle

Converts to this type from the input type.

impl From<Vmar> for NullableHandle

fn from(x: Vmar) -> NullableHandle

Converts to this type from the input type.

impl From<Vmo> for NullableHandle

fn from(x: Vmo) -> NullableHandle

Converts to this type from the input type.

impl HandleBased for NullableHandle

fn into_raw(self) -> u32

Converts the handle into it’s raw representation.

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

Converts the value into its inner handle.

fn from_handle(handle: NullableHandle) -> 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 Hash for NullableHandle

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 NullableHandle

fn cmp(&self, other: &NullableHandle) -> 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 NullableHandle

fn eq(&self, other: &NullableHandle) -> 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 NullableHandle

fn partial_cmp(&self, other: &NullableHandle) -> 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 NullableHandle

impl StructuralPartialEq for NullableHandle