Struct tokio::net::udp::UdpFramed

source ·
pub struct UdpFramed<C> { /* private fields */ }
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.

Create a new UdpFramed backed by the given socket and codec. That will continue to call decode_eof until the decoder has cleared the entire buffer.

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.

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

Trait Implementations§

Formats the value using the given formatter. Read more
The type of value that the sink accepts.
The type of value produced by the sink when an error occurs.
Begin the process of sending a value to the sink. Read more
Flush all output from this sink, if necessary. Read more
A method to indicate that no more values will ever be pushed into this sink. Read more
Creates a new object which will produce a synchronous sink. Read more
Composes a function in front of the sink. Read more
Composes a function in front of the sink. Read more
Transforms the error returned by the sink.
Map this sink’s error to any error implementing From for this sink’s Error, returning a new sink. Read more
Adds a fixed-size buffer to the current sink. Read more
A future that completes when the sink has finished processing all pending requests. Read more
A future that completes after the given item has been fully processed into the sink, including flushing. Read more
A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
The type of item this stream will yield on success.
The type of error this stream may generate.
Attempt to pull out the next value of this stream, returning None if the stream is finished. Read more
Creates an iterator which blocks the current thread until each item of this stream is resolved. Read more
Converts this stream into a Future. Read more
Converts a stream of type T to a stream of type U. Read more
Converts a stream of error type T to a stream of error type U. Read more
Filters the values produced by this stream according to the provided predicate. Read more
Filters the values produced by this stream while simultaneously mapping them to a different type. Read more
Chain on a computation for when a value is ready, passing the resulting item to the provided closure f. Read more
Chain on a computation for when a value is ready, passing the successful results to the provided closure f. Read more
Chain on a computation for when an error happens, passing the erroneous result to the provided closure f. Read more
Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more
Execute an accumulating computation over a stream, collecting all the values into one final result. Read more
Skip elements on this stream while the predicate provided resolves to true. Read more
Take elements from this stream while the predicate provided resolves to true. Read more
Runs this stream to completion, executing the provided closure for each element on the stream. Read more
Map this stream’s error to any error implementing From for this stream’s Error, returning a new stream. Read more
Creates a new stream of at most amt items of the underlying stream. Read more
Creates a new stream which skips amt items of the underlying stream. Read more
Fuse a stream such that poll will never again be called once it has finished. Read more
Borrows a stream, rather than consuming it. Read more
👎Deprecated: functionality provided by select now
An adapter for merging the output of two streams. Read more
An adapter for zipping two streams together. Read more
Adapter for chaining two stream. Read more
Creates a new stream which exposes a peek method. Read more
An adaptor for chunking up items of the stream inside a vector. Read more
Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first. Read more
A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
Do something with each item of this stream, afterwards passing it on. Read more
Do something with the error of this stream, afterwards passing it on. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.