Struct tokio_udp_framed::UdpFramedRecv[][src]

pub struct UdpFramedRecv<T, C> { /* fields omitted */ }

A Stream of messages decoded from a UdpSocket.

Implementations

impl<T, C> UdpFramedRecv<T, C> where
    T: Borrow<UdpSocket>, 
[src]

pub fn new(socket: T, codec: C) -> UdpFramedRecv<T, 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 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.

pub fn into_inner(self) -> T[src]

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

Trait Implementations

impl<T, C> Debug for UdpFramedRecv<T, C> where
    T: Borrow<UdpSocket>,
    C: Debug
[src]

impl<T, C> Stream for UdpFramedRecv<T, C> where
    T: Borrow<UdpSocket>,
    C: Decoder
[src]

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

Values yielded by the stream.

impl<'__pin, T, C> Unpin for UdpFramedRecv<T, C> where
    __Origin<'__pin, T, C>: Unpin
[src]

Auto Trait Implementations

impl<T, C> RefUnwindSafe for UdpFramedRecv<T, C> where
    C: RefUnwindSafe,
    T: RefUnwindSafe
[src]

impl<T, C> Send for UdpFramedRecv<T, C> where
    C: Send,
    T: Send
[src]

impl<T, C> Sync for UdpFramedRecv<T, C> where
    C: Sync,
    T: Sync
[src]

impl<T, C> UnwindSafe for UdpFramedRecv<T, C> where
    C: UnwindSafe,
    T: UnwindSafe
[src]

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> StreamExt for T where
    T: 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

impl<S> TryStreamExt for S where
    S: TryStream + ?Sized
[src]