Struct tokio_util::udp::UdpFramed

#[must_use = "sinks do nothing unless polled"]
pub struct UdpFramed<C> { /* fields omitted */ }

This is supported on feature="udp" and feature="codec" only.

A unified Stream and Sink interface to an underlying UdpSocket, using the Encoder and Decoder traits to encode and decode frames.

Raw UDP sockets work with datagrams, but higher-level code usually wants to batch these into meaningful chunks, called "frames". This method layers framing on top of this socket by using the Encoder and Decoder traits to handle encoding and decoding of messages frames. Note that the incoming and outgoing frame types may be distinct.

This function returns a single object that is both Stream and Sink; grouping this into a single object is often useful for layering things which require both read and write access to the underlying object.

If you want to work more directly with the streams and sink, consider calling split on the UdpFramed returned by this method, which will break them into separate objects, allowing them to interact more easily.

Methods

impl<C> UdpFramed<C>

pub fn new(socket: UdpSocket, codec: C) -> UdpFramed<C>

This is supported on feature="udp" and feature="codec" only.

Create a new UdpFramed backed by the given socket and codec.

See struct level documentation for more details.

pub fn get_ref(&self) -> &UdpSocket

This is supported on feature="udp" and feature="codec" only.

Returns a reference to the underlying I/O stream wrapped by Framed.

Note

Care should be taken to not tamper with the underlying stream of data coming in as it may corrupt the stream of frames otherwise being worked with.

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

This is supported on feature="udp" and feature="codec" only.

Returns a mutable reference to the underlying I/O stream wrapped by Framed.

Note

Care should be taken to not tamper with the underlying stream of data coming in as it may corrupt the stream of frames otherwise being worked with.

pub fn into_inner(self) -> UdpSocket

This is supported on feature="udp" and feature="codec" only.

Consumes the Framed, returning its underlying I/O stream.

Trait Implementations

impl<C: Debug> Debug for UdpFramed<C>

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

Formats the value using the given formatter.

impl<C: Decoder + Unpin> Stream for UdpFramed<C>

type Item = Result<(C::Item, SocketAddr), C::Error>

Values yielded by the stream.

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

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

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

Returns the bounds on the remaining length of the stream.

impl<C: Encoder + Unpin> Sink<(<C as Encoder>::Item, SocketAddr)> for UdpFramed<C>

type Error = C::Error

The type of value produced by the sink when an error occurs.

fn poll_ready(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(
    self: Pin<&mut Self>,
    item: (C::Item, SocketAddr)
) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.