Struct Socket

pub struct Socket { /* private fields */ }

Socket. Provides cross-platform adapter for system’s socket.

Implementations

impl Socket

pub fn new(socket_option: SocketOption) -> Result<Socket>

Constructs a new Socket.

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

Send packet to target.

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

Receive packet.

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

Receive packet with sender address.

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

Write data to the socket and send to the target. Return how many bytes were written.

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

Read data from the socket. Return how many bytes were read.

pub fn bind(&self, addr: SocketAddr) -> Result<()>

Bind socket to address.

pub fn set_receive_timeout(&self, timeout: Option<Duration>) -> Result<()>

Set receive timeout.

pub fn set_ttl(&self, ttl: u32, ip_version: IpVersion) -> Result<()>

Set TTL or Hop Limit.

pub fn connect(&self, addr: SocketAddr) -> Result<()>

Initiate TCP connection.

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

Shutdown TCP connection.

pub fn listen(&self, backlog: i32) -> Result<()>

Listen TCP connection.

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

Accept TCP connection.

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

Get peer address.

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

Get local address.

pub fn connect_timeout( &self, addr: &SocketAddr, timeout: Duration, ) -> Result<()>

Initiate a connection on this socket to the specified address, only only waiting for a certain period of time for the connection to be established. The non-blocking state of the socket is overridden by this function.

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

pub fn set_broadcast(&self, broadcast: bool) -> Result<()>

Set the value of the SO_BROADCAST option for this socket.

When enabled, this socket is allowed to send packets to a broadcast address.

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

Get the value of the SO_ERROR option on this socket.

pub fn set_keepalive(&self, keepalive: bool) -> Result<()>

Set value for the SO_KEEPALIVE option on this socket.

Enable sending of keep-alive messages on connection-oriented sockets.

pub fn set_receive_buffer_size(&self, size: usize) -> Result<()>

Set value for the SO_RCVBUF option on this socket.

Changes the size of the operating system’s receive buffer associated with the socket.

pub fn set_reuse_address(&self, reuse: bool) -> Result<()>

Set value for the SO_REUSEADDR option on this socket.

This indicates that futher calls to bind may allow reuse of local addresses.

pub fn set_send_buffer_size(&self, size: usize) -> Result<()>

Set value for the SO_SNDBUF option on this socket.

Changes the size of the operating system’s send buffer associated with the socket.

pub fn set_send_timeout(&self, duration: Option<Duration>) -> Result<()>

Set value for the SO_SNDTIMEO option on this socket.

If timeout is None, then write and send calls will block indefinitely.

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

Set the value of the TCP_NODELAY option on this socket.

If set, segments are always sent as soon as possible, even if there is only a small amount of data.

Trait Implementations

impl Clone for Socket

fn clone(&self) -> Socket

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Socket

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

Formats the value using the given formatter.