Struct sunrise_libuser::types::Handle

#[repr(transparent)]pub struct Handle(pub NonZeroU32);

A Handle is a sort of reference to a Kernel Object. Its underlying representation is that of a u32. Furthermore, an Option is also guaranteed to be represented on a u32, with None represented as 0. This allows handle to be used directly in the syscall functions.

Handles are closed automatically when Dropped via close_handle.

Implementations

impl Handle

pub fn new(handle: u32) -> Handle

Creates a new handle from the given number. This number should come from a raw syscall. Constructing a handle from an arbitrary number is not unsafe, but may lead to extremely confusing code.

pub fn as_ref(&self) -> HandleRef

Creates a new reference to this handle. See the documentation of HandleRef for more information.

pub fn as_ref_static(&self) -> HandleRef<'static>

Creates a new static reference to this handle. See the documentation of HandleRef for more information.

The kernel guarantees that a Handle is never reused. If the parent Handle dies before this HandleRef is dropped, every function taking this HandleRef will fail with sunrise_libkern::error::KernelError::InvalidHandle

Trait Implementations

impl Debug for Handle

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

Formats the value using the given formatter.

impl Drop for Handle

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for Handle

impl PartialEq<Handle> for Handle

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

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

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

This method tests for !=.

impl StructuralEq for Handle

impl StructuralPartialEq for Handle