Struct Socket

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

An object representing a Zircon socket

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

Implementations

impl Socket

pub fn create_stream() -> (Socket, Socket)

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

Wraps zx_socket_create.

Panics

If the process’ job policy denies socket creation or the kernel reports no memory available to create a new socket.

pub fn create_datagram() -> (Socket, Socket)

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

Wraps zx_socket_create.

Panics

If the process’ job policy denies socket creation or the kernel reports no memory available to create a new socket.

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

Write the given bytes into the socket.

Return value (on success) is number of bytes actually written.

Wraps zx_socket_write.

pub unsafe fn write_raw( &self, bytes: *const u8, len: usize, ) -> Result<usize, Status>

Write the given bytes into the socket.

Return value (on success) is number of bytes actually written.

Safety

bytes must be valid to read from for len bytes.

Wraps zx_socket_write.

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

Write the given bytes into the socket, with options.

Return value (on success) is number of bytes actually written.

Wraps zx_socket_write.

pub unsafe fn write_raw_opts( &self, bytes: *const u8, len: usize, opts: SocketWriteOpts, ) -> Result<usize, Status>

Write the given bytes into the socket, with options.

Return value (on success) is number of bytes actually written.

Safety

bytes must be valid to read from for len bytes.

Wraps zx_socket_write.

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

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

Wraps zx_socket_read.

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

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

Wraps zx_socket_read.

pub unsafe fn read_raw( &self, bytes: *mut u8, len: usize, ) -> Result<usize, Status>

Read the given bytes from the socket.

Return value (on success) is number of bytes actually read.

Safety

bytes must be valid to write to for len bytes.

Wraps zx_socket_read.

pub unsafe fn read_raw_opts( &self, bytes: *mut u8, len: usize, opts: SocketReadOpts, ) -> Result<usize, Status>

Read the given bytes from the socket, with options.

Return value (on success) is number of bytes actually read.

Safety

bytes must be valid to write to for len bytes.

Wraps zx_socket_read.

pub fn read_uninit<'a>( &self, bytes: &'a mut [MaybeUninit<u8>], ) -> Result<&'a mut [u8], Status>

Like Socket::read_uninit_opts with default options.

pub fn read_uninit_opts<'a>( &self, bytes: &'a mut [MaybeUninit<u8>], opts: SocketReadOpts, ) -> Result<&'a mut [u8], Status>

Same as Socket::read_opts, but reads into memory that might not be initialized, returning an initialized slice of bytes on success.

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

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

Implements the ZX_SOCKET_DISPOSITION_WRITE_DISABLED option of zx_socket_set_disposition.

pub fn set_disposition( &self, disposition: Option<SocketWriteDisposition>, disposition_peer: Option<SocketWriteDisposition>, ) -> Result<(), Status>

Sets the disposition of write calls for a socket handle and its peer.

Wraps zx_socket_set_disposition.

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

Returns the number of bytes available on the socket.

pub fn info(&self) -> Result<SocketInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_SOCKET topic.

impl Socket

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

impl Socket

pub fn set_rx_threshold(&self, val: &usize) -> Result<(), Status>

impl Socket

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

impl Socket

pub fn set_tx_threshold(&self, val: &usize) -> Result<(), Status>

Trait Implementations

impl AsHandleRef for Socket

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

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

fn raw_handle(&self) -> u32

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

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

Waits on a handle. Wraps the zx_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. zx_object_wait_async syscall.

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

Get the Property::NAME property for this object.

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

Set the Property::NAME property for this object.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.

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

Returns the koid (kernel object ID) for this handle.

impl CompatFrom<Socket> for Socket

fn compat_from(value: Socket) -> Socket

Converts value into a value of this type.

impl Debug for Socket

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

Formats the value using the given formatter.

impl Encodable for Socket

type Encoded = WireSocket

The wire type for the value.

const COPY_OPTIMIZATION: CopyOptimization<Self, Self::Encoded> = _

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

impl EncodableOption for Socket

type EncodedOption = WireOptionalSocket

The wire type for the optional value.

impl<E> Encode<E> for Socket

where E: HandleEncoder + ?Sized,

fn encode( self, encoder: &mut E, out: &mut MaybeUninit<<Socket as Encodable>::Encoded>, ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.

impl<E> EncodeOption<E> for Socket

where E: HandleEncoder + ?Sized,

fn encode_option( this: Option<Socket>, encoder: &mut E, out: &mut MaybeUninit<<Socket as EncodableOption>::EncodedOption>, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl From<Handle> for Socket

fn from(handle: Handle) -> Socket

Converts to this type from the input type.

impl From<Socket> for Handle

fn from(x: Socket) -> Handle

Converts to this type from the input type.

impl FromWire<WireSocket> for Socket

fn from_wire(wire: WireSocket) -> Socket

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<WireOptionalSocket> for Socket

fn from_wire_option(wire: WireOptionalSocket) -> Option<Socket>

Converts the given wire to an option of this type.

impl HandleBased for Socket

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) -> Handle

Converts the value into its inner handle.

fn into_raw(self) -> u32

Converts the handle into it’s raw representation.

fn from_handle(handle: Handle) -> 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 Socket

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 Socket

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

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

fn partial_cmp(&self, other: &Socket) -> 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 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 zx_object_signal_peer syscall.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the handle has received the PEER_CLOSED signal.

impl Eq for Socket

impl StructuralPartialEq for Socket