Struct HandleRef 

pub struct HandleRef<'a>(/* private fields */);

A reference to a Handle. Can be derived from a Handle or any other type implementing AsHandleRef.

Implementations

impl HandleRef<'_>

pub fn duplicate( &self, rights: Rights, ) -> impl Future<Output = Result<Handle, Error>> + 'static + use<>

Replace this handle with a new handle to the same object, with different rights.

pub fn signal( &self, set: Signals, clear: Signals, ) -> impl Future<Output = Result<(), Error>> + use<>

Assert and deassert signals on this handle.

pub fn get_koid(&self) -> impl Future<Output = Result<u64, Error>>

Methods from Deref<Target = Handle>

pub fn id(&self) -> u32

Returns the ID of the Handle. This should be unique to the handle for its lifetime.

pub fn has_client(&self) -> bool

Checks if there is an active client for this handle.

Only really useful if you are doing something when this function returning false, and you want to fail fast with a specific error.

pub fn as_unowned<H: HandleBased>(&self) -> Unowned<H>

Convert this into an unowned handle (one that is borrowed and will not close when dropped).

An example:

let handle: &Handle = /* ... */;
let socket = handle.as_unowned::<fdomain_client::Socket>();
let mut buf: [u8; 4096] = [0; 4096];
socket.read(&mut buf[..]).await?;

This is only really useful for contexts in which the handles are going to be stored and retrieved from a data structure and potentially used as arbitrary handle-based data types.

Trait Implementations

impl<'a> Debug for HandleRef<'a>

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

Formats the value using the given formatter.

impl Deref for HandleRef<'_>

type Target = Handle

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> Hash for HandleRef<'a>

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

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<'a> Ord for HandleRef<'a>

fn cmp(&self, other: &HandleRef<'a>) -> 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<'a> PartialEq for HandleRef<'a>

fn eq(&self, other: &HandleRef<'a>) -> 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<'a> PartialOrd for HandleRef<'a>

fn partial_cmp(&self, other: &HandleRef<'a>) -> 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<'a> Eq for HandleRef<'a>

impl<'a> StructuralPartialEq for HandleRef<'a>