Struct UdpStream 

pub struct UdpStream<const BUF_SIZE: usize> { /* private fields */ }

A non-blocking async UdpSocket with ability to recv_from via next and send_to via push.

BUF_SIZE

Messages received via [UdpStream::next] will be provided as an array of bytes of length BUF_SIZE. This is a generic const to allow avoid us having to allocate a 65k buffer on each call to next in order to cover the max possible UDP datagram size.

It is your responsibility to ensure that BUF_SIZE is large enough to hold the largest UDP datagram your protocol expects; if it is smaller than the incoming datagram size, the datagram will be truncated in the output from next. You cannot rely on the returned bytes_read value to indicate truncation as this will also be set to the buffer length, not the full size of the truncated message (this is the underlying behaviour of the libc call recv_from).

Note

• This does NOT have exclusive access to the bound port. If you want to guarantee that no other processes bind to the same socket vote thumbs up on issue #22 TODO: implement bind_exclusive etc.)

Trait Implementations

impl<const BUF_SIZE: usize> Debug for UdpStream<BUF_SIZE>

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

Formats the value using the given formatter.

impl<const _BS: usize> EventedUdpSocket for UdpStream<_BS>

fn from_evented_socket(evented_socket: PollEvented<UdpSocket>) -> Result<Self>

Create a new Self from a PollEvented<sys::net::UdpSocket>

fn as_socket(&self) -> &UdpSocket

Provides access to the underlying Socket.

fn as_socket_mut(&mut self) -> &mut UdpSocket

Provides mutable access to the underlying Socket.

fn as_evented_socket_pin( self: Pin<&mut Self>, ) -> Pin<&mut PollEvented<UdpSocket>>

Converts a pinned &mut Self to a pinned &mut of the underlying pollevented socket allowing for calls to traits and functions implemented by PollEvented

fn clear_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<!>>

Clear the readiness state of the underlying socket.

fn bind(addr: SocketAddr) -> Result<Self>

Create a new Self by binding it to a given SocketAddr.

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

Get the local address of the underlying Socket

fn unblock( self: Pin<&mut Self>, error: Result<!>, cx: &mut Context<'_>, ) -> Poll<Result<!>>

Checks whether error will block the underlying Socket and either:

impl<const BUF_SIZE: usize> Stream for UdpStream<BUF_SIZE>

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Receives data from the IO interface once awaited.

Awaiting returns an array of bytes containing the message received, the message length and the target from whence the data came as an Option<io::Result<([u8; BUF_SIZE], usize, SocketAddr)>>

Note

• Messages received via [UdpStream::next] will be provided as an array of bytes of length BUF_SIZE. This is a generic const to allow avoid us having to allocate a 65k buffer on each call to next in order to cover the max possible UDP datagram size.
• It is your responsibility to ensure that BUF_SIZE is large enough to hold the largest UDP datagram your protocol expects; if it is smaller than the incoming datagram size, the datagram will be truncated in the output from next. You cannot rely on the returned bytes_read value to indicate truncation as this will also be set to the buffer length, not the full size of the truncated message (this is the underlying behaviour of the libc call recv_from).
• All bytes after the actual message will be NULL so it can be directly converted to a String, for example, without first slicing. Other data manipulation should take into account the actual length.
• There are no clear situations which could lead to this returning None. Wrapping the returned data in an Option is done purely to maintain a consistent API with expectations on an Iterator / Stream

type Item = Result<([u8; BUF_SIZE], usize, SocketAddr), Error>

Values yielded by the stream.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.