Struct Socket 

pub struct Socket { /* private fields */ }

An owned, non-blocking socket. Closed on drop.

Implementations

impl Socket

pub fn new(family: i32, ty: i32) -> Result<Socket>

Creates a raw non-blocking socket.

pub fn tcp_listen(addr: SocketAddr, opts: &ListenOptions) -> Result<Socket>

A non-blocking TCP listener bound to addr.

pub fn udp_bind(addr: SocketAddr, opts: &UdpOptions) -> Result<Socket>

A non-blocking UDP socket bound to addr.

pub fn tcp_connect(addr: SocketAddr) -> Result<Socket>

Connects a TCP socket to addr, waiting for the handshake, and returns it non-blocking with TCP_NODELAY set. Meant for clients and tests.

pub fn accept(&self) -> Result<(Socket, Option<SocketAddr>)>

Accepts one pending connection without blocking. The new socket is non-blocking.

pub fn recv(&self, buf: &mut [u8]) -> Result<usize>

Receives into buf without blocking. Ok(0) means the peer closed its side.

pub fn recv_into(&self, buf: &mut Vec<u8>) -> Result<usize>

Receives into the spare capacity of buf and extends its length by the bytes read.

pub fn send(&self, buf: &[u8]) -> Result<usize>

Sends from buf without blocking (never raises SIGPIPE).

pub fn send_vectored(&self, bufs: &[&[u8]]) -> Result<usize>

Sends several buffers with one call (sendmsg / WSASend) without blocking. At most 64 buffers are sent per call.

pub fn shutdown(&self, how: Shutdown) -> Result<()>

Shuts down one or both directions.

pub fn set_nodelay(&self, on: bool) -> Result<()>

Sets or clears TCP_NODELAY.

pub fn nodelay(&self) -> Result<bool>

Whether TCP_NODELAY is set.

pub fn set_nonblocking(&self, on: bool) -> Result<()>

Switches non-blocking mode.

pub fn local_addr(&self) -> Result<SocketAddr>

The local address.

pub fn peer_addr(&self) -> Result<SocketAddr>

The peer address.

pub fn take_error(&self) -> Result<Option<Error>>

Reads and clears the pending socket error (SO_ERROR).

pub fn setsockopt_int(&self, level: i32, name: i32, value: i32) -> Result<()>

Sets an integer socket option.

pub fn getsockopt_int(&self, level: i32, name: i32) -> Result<i32>

Reads an integer socket option.

pub fn raw(&self) -> RawSock

The raw handle (still owned by this Socket).

pub unsafe fn from_raw(raw: RawSock) -> Socket

Takes ownership of a raw handle.

Safety

raw must be an open socket that nothing else owns or will close.

pub fn into_raw(self) -> RawSock

Gives up ownership of the raw handle.

pub fn into_tcp_stream(self) -> TcpStream

Converts into a std TCP stream (it stays non-blocking).

pub fn into_tcp_listener(self) -> TcpListener

Converts into a std TCP listener (it stays non-blocking).

pub fn into_udp_socket(self) -> UdpSocket

Converts into a std UDP socket (it stays non-blocking).

pub fn try_clone(&self) -> Result<Socket>

An independent handle to the same socket (dup / WSADuplicateSocket).

impl Socket

pub fn recv_msgs( &self, bufs: &mut [Vec<u8>], meta: &mut [RecvMeta], ) -> Result<usize>

Receives up to bufs.len() (at most BATCH) datagrams without blocking. Each buffer is cleared and filled up to its capacity; meta[i] describes bufs[i]. Returns how many were received, or a WouldBlock error when none was waiting.

pub fn send_msgs(&self, msgs: &[Transmit<'_>]) -> Result<usize>

Sends up to BATCH transmits without blocking. Returns how many were handed to the kernel; a WouldBlock error means none was (the socket buffer is full).

Trait Implementations

impl Debug for Socket

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

Formats the value using the given formatter.

impl From<TcpListener> for Socket

fn from(s: TcpListener) -> Socket

Takes over a std socket. Call set_nonblocking(true) on it first if it will be driven by an event loop.

impl From<TcpStream> for Socket

fn from(s: TcpStream) -> Socket

Takes over a std socket. Call set_nonblocking(true) on it first if it will be driven by an event loop.

impl From<UdpSocket> for Socket

fn from(s: UdpSocket) -> Socket

Takes over a std socket. Call set_nonblocking(true) on it first if it will be driven by an event loop.