Trait SocketOps 

pub trait SocketOps: Configurable {
    // Required methods
    fn bind(&self, local_addr: SocketAddrEx) -> NetResult;
    fn start_connect(
        &self,
        remote_addr: SocketAddrEx,
    ) -> NetResult<ConnectStatus>;
    fn try_send(
        &self,
        src: impl Read + IoBuf,
        options: &mut SendOptions,
    ) -> NetResult<usize>;
    fn try_recv(
        &self,
        dst: impl Write + IoBufMut,
        options: &mut RecvOptions<'_>,
    ) -> NetResult<usize>;
    fn local_addr(&self) -> NetResult<SocketAddrEx>;
    fn peer_addr(&self) -> NetResult<SocketAddrEx>;
    fn shutdown(&self, how: Shutdown) -> NetResult;

    // Provided methods
    fn connect_status(&self) -> NetResult<ConnectStatus> { ... }
    fn listen(&self, _backlog: usize) -> NetResult { ... }
    fn is_listening(&self) -> bool { ... }
    fn try_accept(&self) -> NetResult<Socket> { ... }
    fn recv_available(&self) -> NetResult<usize> { ... }
    fn send_wait_policy(
        &self,
        extra_nonblocking: bool,
    ) -> NetResult<SocketWaitPolicy> { ... }
    fn recv_wait_policy(
        &self,
        extra_nonblocking: bool,
    ) -> NetResult<SocketWaitPolicy> { ... }
}

Operations that can be performed on a socket.

Required Methods

fn bind(&self, local_addr: SocketAddrEx) -> NetResult

Binds an unbound socket to the given address and port.

fn start_connect(&self, remote_addr: SocketAddrEx) -> NetResult<ConnectStatus>

Starts a connection without waiting for asynchronous completion.

fn try_send( &self, src: impl Read + IoBuf, options: &mut SendOptions, ) -> NetResult<usize>

Attempts to send data without parking the caller.

fn try_recv( &self, dst: impl Write + IoBufMut, options: &mut RecvOptions<'_>, ) -> NetResult<usize>

Attempts to receive data without parking the caller.

fn local_addr(&self) -> NetResult<SocketAddrEx>

Get the local endpoint of the socket.

fn peer_addr(&self) -> NetResult<SocketAddrEx>

Get the remote endpoint of the socket.

fn shutdown(&self, how: Shutdown) -> NetResult

Shutdown the socket, closing the connection.

Provided Methods

fn connect_status(&self) -> NetResult<ConnectStatus>

Checks a previously started asynchronous connection.

fn listen(&self, _backlog: usize) -> NetResult

Starts listening on the bound address and port.

fn is_listening(&self) -> bool

Returns whether this socket currently accepts incoming connections.

fn try_accept(&self) -> NetResult<Socket>

Attempts to accept one connection without parking the caller.

fn recv_available(&self) -> NetResult<usize>

Returns the number of bytes that can be read without blocking.

fn send_wait_policy( &self, extra_nonblocking: bool, ) -> NetResult<SocketWaitPolicy>

Returns the send wait policy without acquiring scheduler ownership.

fn recv_wait_policy( &self, extra_nonblocking: bool, ) -> NetResult<SocketWaitPolicy>

Returns the receive wait policy without acquiring scheduler ownership.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl<T: SocketOps + ?Sized> SocketOps for Box<T>

fn bind(&self, local_addr: SocketAddrEx) -> NetResult

fn start_connect(&self, remote_addr: SocketAddrEx) -> NetResult<ConnectStatus>

fn connect_status(&self) -> NetResult<ConnectStatus>

fn listen(&self, backlog: usize) -> NetResult

fn is_listening(&self) -> bool

fn try_accept(&self) -> NetResult<Socket>

fn try_send( &self, src: impl Read + IoBuf, options: &mut SendOptions, ) -> NetResult<usize>

fn try_recv( &self, dst: impl Write + IoBufMut, options: &mut RecvOptions<'_>, ) -> NetResult<usize>

fn recv_available(&self) -> NetResult<usize>

fn local_addr(&self) -> NetResult<SocketAddrEx>

fn peer_addr(&self) -> NetResult<SocketAddrEx>

fn shutdown(&self, how: Shutdown) -> NetResult

Implementors

impl SocketOps for RawSocket

impl SocketOps for Socket

impl SocketOps for TcpSocket

impl SocketOps for UdpSocket

impl SocketOps for UnixSocket