Struct Guest 

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

An object representing a Zircon guest

As essentially a subtype of NullableHandle, it can be freely interconverted.

Implementations

impl Guest

pub fn raw_handle(&self) -> u32

Return the handle’s integer value.

pub fn into_raw(self) -> u32

Return the raw handle’s integer value without closing it when self is dropped.

pub fn unowned(&self) -> Unowned<'_, Guest>

Returns an [Unowned] referring to this handle.

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

Returns a HandleRef referring to this handle.

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

Wraps the zx_handle_duplicate syscall.

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

Wraps the zx_handle_replace syscall.

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

Wraps the zx_object_signal syscall.

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

Wraps the zx_object_wait_one syscall.

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

Wraps the zx_object_wait_async syscall.

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

Wraps a call to the zx_object_get_property syscall for the ZX_PROP_NAME property.

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

Wraps a call to the zx_object_set_property syscall for the ZX_PROP_NAME property.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.

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

Returns the [Koid] for the object referred to by this handle.

impl Guest

pub fn create(hypervisor: &Resource) -> Result<(Guest, Vmar), Status>

pub fn set_trap_bell( &self, addr: GPAddr, size: usize, port: &Port, key: u64, ) -> Result<(), Status>

Set a bell trap for the given guest physical address range that will be delivered on the specified Port.

pub fn set_mem_trap( &self, addr: GPAddr, size: usize, key: u64, ) -> Result<(), Status>

Set a memory trap for the given guest physical address range.

The trap will be delivered through calls to Resume on the guests Vcpu.

pub fn set_io_trap(&self, addr: u16, size: u16, key: u64) -> Result<(), Status>

Set an IO trap for the given port range in the guest.

The trap will be delivered through calls to Resume on the guests Vcpu.

Trait Implementations

impl AsHandleRef for Guest

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.

impl CompatFrom<Guest> for Guest

Available on crate feature fuchsia only.

fn compat_from(value: Guest) -> Guest

Converts value into a value of this type.

impl Debug for Guest

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

Formats the value using the given formatter.

impl<E> Encode<WireGuest, E> for Guest

where E: HandleEncoder + ?Sized,

fn encode( self, encoder: &mut E, out: &mut MaybeUninit<WireGuest>, constraint: <WireGuest as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.

const COPY_OPTIMIZATION: CopyOptimization<Self, W> = _

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

impl<E> EncodeOption<WireOptionalGuest, E> for Guest

where E: HandleEncoder + ?Sized,

fn encode_option( this: Option<Guest>, encoder: &mut E, out: &mut MaybeUninit<WireOptionalGuest>, constraint: (), ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl From<Guest> for NullableHandle

fn from(x: Guest) -> NullableHandle

Converts to this type from the input type.

impl From<NullableHandle> for Guest

fn from(handle: NullableHandle) -> Guest

Converts to this type from the input type.

impl FromWire<WireGuest> for Guest

fn from_wire(wire: WireGuest) -> Guest

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<WireOptionalGuest> for Guest

fn from_wire_option(wire: WireOptionalGuest) -> Option<Guest>

Converts the given wire to an option of this type.

impl HandleBased for Guest

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 into_raw(self) -> u32

Converts the handle into it’s raw representation.

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 Guest

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 Guest

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

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

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

impl StructuralPartialEq for Guest