[][src]Struct tokio_util::udp::UdpFramed

#[must_use = "sinks do nothing unless polled"]pub struct UdpFramed<C> { /* fields omitted */ }
This is supported on crate features net and 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.

Implementations

impl<C> UdpFramed<C>[src]

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

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

See struct level documentation for more details.

pub fn get_ref(&self) -> &UdpSocket[src]

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[src]

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[src]

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

pub fn codec(&self) -> &C[src]

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.

pub fn codec_mut(&mut self) -> &mut C[src]

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.

pub fn read_buffer(&self) -> &BytesMut[src]

Returns a reference to the read buffer.

pub fn read_buffer_mut(&mut self) -> &mut BytesMut[src]

Returns a mutable reference to the read buffer.

Trait Implementations

impl<C: Debug> Debug for UdpFramed<C>[src]

impl<I, C: Encoder<I> + Unpin> Sink<(I, SocketAddr)> for UdpFramed<C>[src]

type Error = C::Error

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

impl<C: Decoder + Unpin> Stream for UdpFramed<C>[src]

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

Values yielded by the stream.

Auto Trait Implementations

impl<C> !RefUnwindSafe for UdpFramed<C>

impl<C> Send for UdpFramed<C> where
    C: Send

impl<C> Sync for UdpFramed<C> where
    C: Sync

impl<C> Unpin for UdpFramed<C> where
    C: Unpin

impl<C> !UnwindSafe for UdpFramed<C>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<St> StreamExt for St where
    St: Stream + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<S, T, E> TryStream for S where
    S: Stream<Item = Result<T, E>> + ?Sized
[src]

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future