Struct MaybeConnectedSocket

pub struct MaybeConnectedSocket<T> { /* private fields */ }

A cheap wrapper around a datagram socket which describes if it is connected to an explicit peer.

This struct essentially forwards its underlying socket’s send_to() method to send() if the socket is explicitly connected to a peer. This is helpful for preventing issues on platforms that do not support send_to on already-connected sockets.

Warning

A socket’s “connectedness” is determined once, when it is created. If the socket is created as connected, then later disconnected from its peer, its send_to() call will fail.

For example, MacOS errors if send_to is used on a socket that’s already connected. Only send can be used. By using MaybeConnectedSocket, you can use the same send and send_to APIs in both client- and server-side code. Clients, usually with connected sockets, will then forward send_to to send, whereas servers, usually with unconnected sockets, will use send_to.

Implementations

impl<T: DatagramSocketSend> MaybeConnectedSocket<T>

pub fn new(inner: T) -> Self

pub fn inner(&self) -> &T

Provides access to the wrapped socket, allowing the user to override send_to() behavior if required.

pub fn into_inner(self) -> T

Consumes self, returning the wrapped socket.

Trait Implementations

impl<T: Clone> Clone for MaybeConnectedSocket<T>

fn clone(&self) -> MaybeConnectedSocket<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: DatagramSocketSend> DatagramSocketSend for MaybeConnectedSocket<T>

fn poll_send(&self, cx: &mut Context<'_>, buf: &[u8]) -> Poll<Result<usize>>

Attempts to send data on the socket to the remote address to which it was previously connected.

fn poll_send_to( &self, cx: &mut Context<'_>, buf: &[u8], addr: SocketAddr, ) -> Poll<Result<usize>>

Attempts to send data on the socket to a given address.

fn poll_send_many( &self, cx: &mut Context<'_>, bufs: &[ReadBuf<'_>], ) -> Poll<Result<usize>>

Attempts to send multiple packets of data on the socket to the remote address to which it was previously connected.

fn as_udp_socket(&self) -> Option<&UdpSocket>

If the underlying socket is a UdpSocket, return the reference to it.

fn peer_addr(&self) -> Option<SocketAddr>

Returns the socket address of the remote peer this socket was connected to.