Struct HandleInfo

pub struct HandleInfo { /* private fields */ }

Metadata information for a handle in a processargs message. Contains a handle type and an unsigned 16-bit value, whose meaning is handle type dependent.

Implementations

impl HandleInfo

pub const fn new(htype: HandleType, arg: u16) -> Self

Create a handle info struct from a handle type and an argument.

For example, a HandleInfo::new(HandleType::FileDescriptor, 32) identifies the respective handle as file descriptor 32.

Corresponds to PA_HND in processargs.h.

pub fn handle_type(&self) -> HandleType

Returns the handle type for this handle info struct.

pub fn arg(&self) -> u16

Returns the argument for this handle info struct.

pub const fn as_raw(&self) -> u32

Convert the handle info into a raw u32 value for FFI purposes.

Trait Implementations

impl Clone for HandleInfo

fn clone(&self) -> HandleInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HandleInfo

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

Formats the value using the given formatter.

impl From<HandleType> for HandleInfo

An implementation of the From trait to create a HandleInfo from a HandleType with an argument of 0.

fn from(ty: HandleType) -> Self

Converts to this type from the input type.

impl PartialEq for HandleInfo

fn eq(&self, other: &HandleInfo) -> 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 TryFrom<u32> for HandleInfo

fn try_from(value: u32) -> Result<HandleInfo, HandleInfoError>

Attempt to convert a u32 to a handle ID value. Can fail if the value represents an unknown handle type or is otherwise invalid.

Useful to convert existing handle info values received through FIDL APIs, e.g. from a client that creates them using the PA_HND macro in processargs.h from C/C++.

type Error = HandleInfoError

The type returned in the event of a conversion error.

impl Copy for HandleInfo

impl Eq for HandleInfo

impl StructuralPartialEq for HandleInfo