Struct MessageDatagram 

pub struct MessageDatagram<D> { /* private fields */ }

Available on crate feature net only.

A whole-message sender/receiver over a DatagramSocket (a UdpSocket, a UnixDatagram, or — under the mock feature — a MockDatagramSocket). It owns the socket and reuses one receive buffer, so each datagram is exchanged as a #[bin] value — the datagram counterpart to MessageStream. Unlike a stream, a datagram socket talks to many peers, so every call carries the peer address.

Implementations

impl<D> MessageDatagram<D>

pub fn new(sock: D) -> Self

Wrap a datagram socket, with a receive buffer sized for the largest datagram (64 KiB).

pub fn with_capacity(sock: D, capacity: usize) -> Self

Wrap a socket with a receive buffer of capacity bytes. A datagram larger than this is truncated (as the OS itself would truncate an oversized recv).

pub fn get_ref(&self) -> &D

Borrow the underlying socket (e.g. for connect, multicast, or a read timeout).

pub fn get_mut(&mut self) -> &mut D

Mutably borrow the underlying socket.

pub fn into_inner(self) -> D

Recover the underlying socket.

impl<D: DatagramSocket> MessageDatagram<D>

pub fn send_message<T: BitEncode>( &self, msg: &T, addr: &D::Addr, ) -> Result<usize, BitError>

Encode msg and send it as one datagram to addr. Returns the bytes sent.

Errors

A codec BitError or an I/O send error.

pub fn recv_message<T: BitDecode + BitEncode>( &mut self, ) -> Result<(T, D::Addr), BitError>

Receive one datagram and decode it as a T, with the sender’s address.

Errors

A codec BitError (the datagram wasn’t a valid T) or an I/O receive error.

Trait Implementations

impl<D: Debug> Debug for MessageDatagram<D>

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

Formats the value using the given formatter.