Struct magenta::Port

pub struct Port(_);

An object representing a Magenta port.

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

Methods

impl Port

fn create(opts: PortOpts) -> Result<Port, Status>

Create an IO port, allowing IO packets to be read and enqueued.

Wraps the mx_port_create syscall.

fn queue(&self, packet: &Packet) -> Result<(), Status>

Attempt to queue a user packet to the IO port.

Wraps the mx_port_queue syscall.

fn wait(&self, deadline: mx_time_t) -> Result<Packet, Status>

Wait for a packet to arrive on a (V2) port.

Wraps the mx_port_wait syscall.

fn cancel<H>(&self, source: &H, key: u64) -> Result<(), Status> where
    H: HandleBased, 

Cancel pending wait_async calls for an object with the given key.

Wraps the mx_port_cancel syscall.

Trait Implementations

impl Debug for Port

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

Formats the value using the given formatter.

impl Eq for Port

impl PartialEq for Port

fn eq(&self, __arg_0: &Port) -> bool

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

fn ne(&self, __arg_0: &Port) -> bool

This method tests for !=.

impl AsHandleRef for Port

fn as_handle_ref(&self) -> HandleRef

Get a reference to the handle. One important use of such a reference is for object_wait_many.

fn raw_handle(&self) -> mx_handle_t

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 signal_handle(
    &self,
    clear_mask: Signals,
    set_mask: Signals
) -> Result<(), Status>

Set and clear userspace-accessible signal bits on an object. Wraps the mx_object_signal syscall.

fn wait_handle(
    &self,
    signals: Signals,
    deadline: mx_time_t
) -> Result<Signals, Status>

Waits on a handle. Wraps the mx_object_wait_one syscall.

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. mx_object_wait_async syscall.

impl From<Handle> for Port

fn from(handle: Handle) -> Self

Performs the conversion.

impl Into<Handle> for Port

fn into(self) -> Handle

Performs the conversion.

impl HandleBased for Port

fn duplicate_handle(&self, rights: Rights) -> Result<Self, Status>

Duplicate a handle, possibly reducing the rights available. Wraps the mx_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 mx_handle_replace syscall.