Struct magenta::Socket

pub struct Socket(_);

An object representing a Magenta socket.

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

Methods

impl Socket

fn create(opts: SocketOpts) -> Result<(Socket, Socket), Status>

Create a socket, accessed through a pair of endpoints. Data written into one may be read from the other.

Wraps mx_socket_create.

fn write(&self, opts: SocketWriteOpts, bytes: &[u8]) -> Result<usize, Status>

Write the given bytes into the socket. Return value (on success) is number of bytes actually written.

Wraps mx_socket_write.

fn read(&self, opts: SocketReadOpts, bytes: &mut [u8]) -> Result<usize, Status>

Read the given bytes from the socket. Return value (on success) is number of bytes actually read.

Wraps mx_socket_read.

fn half_close(&self) -> Result<(), Status>

Close half of the socket, so attempts by the other side to write will fail.

Implements the MX_SOCKET_HALF_CLOSE option of mx_socket_write.

fn outstanding_read_bytes(&self) -> Result<usize, Status>

Trait Implementations

impl Debug for Socket

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

Formats the value using the given formatter.

impl Eq for Socket

impl PartialEq for Socket

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

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

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

This method tests for !=.

impl AsHandleRef for Socket

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 Socket

fn from(handle: Handle) -> Self

Performs the conversion.

impl Into<Handle> for Socket

fn into(self) -> Handle

Performs the conversion.

impl HandleBased for Socket

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.

impl Peered for Socket

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

Set and clear userspace-accessible signal bits on the object's peer. Wraps the mx_object_signal_peer syscall.