Struct tokio_util::udp::UdpFramed [−][src]
pub struct UdpFramed<C, T = UdpSocket> { /* fields omitted */ }
net
and codec
only.Expand description
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.
Implementations
Create a new UdpFramed
backed by the given socket and codec.
See struct level documentation for more details.
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.
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.
Returns a reference to the underlying codec wrapped by
Framed
.
Note that care should be taken to not tamper with the underlying codec as it may corrupt the stream of frames otherwise being worked with.
Returns a mutable reference to the underlying codec wrapped by
UdpFramed
.
Note that care should be taken to not tamper with the underlying codec as it may corrupt the stream of frames otherwise being worked with.
Returns a reference to the read buffer.
Returns a mutable reference to the read buffer.
Consumes the Framed
, returning its underlying I/O stream.
Trait Implementations
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. Read more