Struct udp_stream::UdpStream

pub struct UdpStream { /* private fields */ }

An I/O object representing a UDP stream connected to a remote endpoint.

A UDP stream can either be created by connecting to an endpoint, via the connect method, or by accepting a connection from a listener.

Implementations

impl UdpStream

pub async fn connect(addr: SocketAddr) -> Result<Self, Error>

Create a new UDP stream connected to the specified address.

This function will create a new UDP socket and attempt to connect it to the addr provided. The returned future will be resolved once the stream has successfully connected, or it will return an error if one occurs.

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

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

pub fn shutdown(&self)

Trait Implementations

impl AsyncRead for UdpStream

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut ReadBuf<'_>
) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl AsyncWrite for UdpStream

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

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown(
    self: Pin<&mut Self>,
    _cx: &mut Context<'_>
) -> Poll<Result<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl Debug for UdpStream

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

Formats the value using the given formatter.

impl Drop for UdpStream

fn drop(&mut self)

Executes the destructor for this type.