[−][src]Struct tokio::net::UdpFramed

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

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>[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.

Trait Implementations

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

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

Values yielded by the stream.

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

type Error = <C as Encoder>::Error

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

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

Auto Trait Implementations

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

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

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

impl<C> !UnwindSafe for UdpFramed<C>

impl<C> !RefUnwindSafe for UdpFramed<C>

Blanket Implementations

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

fn throttle(self, duration: Duration) -> Throttle<Self> where
    Self: Sized, [src]

Throttle down the stream by enforcing a fixed delay between items. Read more

ⓘImportant traits for Timeout<T>
fn timeout(self, timeout: Duration) -> Timeout<Self> where
    Self: Sized, [src]

Creates a new stream which allows self until timeout. Read more

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

impl<T, U> Into<U> for T where
    U: From<T>, [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<T> Borrow<T> for T where
    T: ?Sized, [src]

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

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

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<T> StreamExt for T where
    T: Stream + ?Sized, [src]

ⓘImportant traits for Next<'_, St>
fn next(&mut self) -> Next<Self> where
    Self: Unpin, [src]

Creates a future that resolves to the next item in the stream. Read more

ⓘImportant traits for StreamFuture<St>
fn into_future(self) -> StreamFuture<Self> where
    Self: Unpin, [src]

Converts this stream into a future of (next_item, tail_of_stream). If the stream terminates, then the next item is [None]. Read more

fn map<T, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> T, [src]

Maps this stream's items to a different type, returning a new stream of the resulting type. Read more

fn enumerate(self) -> Enumerate<Self>[src]

Creates a stream which gives the current iteration count as well as the next value. Read more

fn filter<Fut, F>(self, f: F) -> Filter<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>, [src]

Filters the values produced by this stream according to the provided asynchronous predicate. Read more

fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = Option<T>>, [src]

Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future, [src]

Computes from this stream's items new items of a different type using an asynchronous closure. Read more

ⓘImportant traits for Collect<St, C>
fn collect<C>(self) -> Collect<Self, C> where
    C: Default + Extend<Self::Item>, [src]

Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more

ⓘImportant traits for Concat<St>
fn concat(self) -> Concat<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator,
    Self::Item: Default, [src]

Concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more

ⓘImportant traits for Fold<St, Fut, T, F>
fn fold<T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F> where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: Future<Output = T>, [src]

Execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Item: Stream, [src]

Flattens a stream of streams into just one continuous stream. Read more

fn skip_while<Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>, [src]

Skip elements on this stream while the provided asynchronous predicate resolves to true. Read more

fn take_while<Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>, [src]

Take elements from this stream while the provided asynchronous predicate resolves to true. Read more

ⓘImportant traits for ForEach<St, Fut, F>
fn for_each<Fut, F>(self, f: F) -> ForEach<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = ()>, [src]

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more

ⓘImportant traits for ForEachConcurrent<St, Fut, F>
fn for_each_concurrent<Fut, F, impl Into>>(
    self,
    limit: impl Into>,
    f: F
) -> ForEachConcurrent<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = ()>,
    impl Into>: Into<Option<usize>>, [src]

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available. Read more

fn take(self, n: u64) -> Take<Self>[src]

Creates a new stream of at most n items of the underlying stream. Read more

fn skip(self, n: u64) -> Skip<Self>[src]

Creates a new stream which skips n items of the underlying stream. Read more

fn fuse(self) -> Fuse<Self>[src]

Fuse a stream such that poll_next will never again be called once it has finished. This method can be used t turn any Stream into a FusedStream. Read more

ⓘImportant traits for &'_ mut F
fn by_ref(&mut self) -> &mut Self[src]

Borrows a stream, rather than consuming it. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, [src]

Catches unwinding panics while polling the stream. Read more

ⓘImportant traits for Pin<P>
fn boxed<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a + Send>> where
    Self: Send + 'a, [src]

Wrap the stream in a Box, pinning it. Read more

ⓘImportant traits for Pin<P>
fn boxed_local<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a>> where
    Self: 'a, [src]

Wrap the stream in a Box, pinning it. Read more

fn buffered(self, n: usize) -> Buffered<Self> where
    Self::Item: Future, [src]

An adaptor for creating a buffered list of pending futures. Read more

fn buffer_unordered(self, n: usize) -> BufferUnordered<Self> where
    Self::Item: Future, [src]

An adaptor for creating a buffered list of pending futures (unordered). Read more

fn zip<St>(self, other: St) -> Zip<Self, St> where
    St: Stream, [src]

An adapter for zipping two streams together. Read more

fn chain<St>(self, other: St) -> Chain<Self, St> where
    St: Stream<Item = Self::Item>, [src]

Adapter for chaining two stream. Read more

fn peekable(self) -> Peekable<Self>[src]

Creates a new stream which exposes a peek method. Read more

fn chunks(self, capacity: usize) -> Chunks<Self>[src]

An adaptor for chunking up items of the stream inside a vector. Read more

ⓘImportant traits for Forward<St, Si>
fn forward<S>(self, sink: S) -> Forward<Self, S> where
    S: Sink<Self::Ok>,
    Self: TryStream<Error = <S as Sink<Self::Ok>>::Error>, [src]

A future that completes after the given stream has been fully processed into the sink and the sink has been flushed and closed. Read more

fn split<Item>(self) -> (SplitSink<Self, Item>, SplitStream<Self>) where
    Self: Sink<Item>, [src]

Splits this Stream + Sink object into separate Stream and Sink objects. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), [src]

Do something with each item of this stream, afterwards passing it on. Read more

ⓘImportant traits for Either<A, B>
fn left_stream<B>(self) -> Either<Self, B> where
    B: Stream<Item = Self::Item>, [src]

Wrap this stream in an Either stream, making it the left-hand variant of that Either. Read more

ⓘImportant traits for Either<A, B>
fn right_stream<B>(self) -> Either<B, Self> where
    B: Stream<Item = Self::Item>, [src]

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

fn poll_next_unpin(&mut self, cx: &mut Context) -> Poll<Option<Self::Item>> where
    Self: Unpin, [src]

A convenience method for calling [Stream::poll_next] on [Unpin] stream types. Read more

ⓘImportant traits for SelectNextSome<'_, St>
fn select_next_some(&mut self) -> SelectNextSome<Self> where
    Self: Unpin + FusedStream, [src]

Returns a [Future] that resolves when the next item in this stream is ready. Read more

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

fn err_into<E>(self) -> ErrInto<Self, E> where
    Self::Error: Into<E>, [src]

Wraps the current stream in a new stream which converts the error type into the one provided. Read more

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
    F: FnMut(Self::Ok) -> T, [src]

Wraps the current stream in a new stream which maps the success value using the provided closure. Read more

fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where
    F: FnMut(Self::Error) -> E, [src]

Wraps the current stream in a new stream which maps the error value using the provided closure. Read more

fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where
    F: FnMut(Self::Ok) -> Fut,
    Fut: TryFuture<Error = Self::Error>, [src]

Chain on a computation for when a value is ready, passing the successful results to the provided closure f. Read more

fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where
    F: FnMut(Self::Error) -> Fut,
    Fut: TryFuture<Ok = Self::Ok>, [src]

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f. Read more

fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
    F: FnMut(&Self::Ok), [src]

Do something with the success value of this stream, afterwards passing it on. Read more

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
    F: FnMut(&Self::Error), [src]

Do something with the error value of this stream, afterwards passing it on. Read more

fn into_stream(self) -> IntoStream<Self>[src]

Wraps a [TryStream] into a type that implements Stream Read more

ⓘImportant traits for TryNext<'_, St>
fn try_next(&mut self) -> TryNext<Self> where
    Self: Unpin, [src]

Creates a future that attempts to resolve the next item in the stream. If an error is encountered before the next item, the error is returned instead. Read more

ⓘImportant traits for TryForEach<St, Fut, F>
fn try_for_each<Fut, F>(self, f: F) -> TryForEach<Self, Fut, F> where
    F: FnMut(Self::Ok) -> Fut,
    Fut: TryFuture<Ok = (), Error = Self::Error>, [src]

Attempts to run this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more

fn try_skip_while<Fut, F>(self, f: F) -> TrySkipWhile<Self, Fut, F> where
    F: FnMut(&Self::Ok) -> Fut,
    Fut: TryFuture<Ok = bool, Error = Self::Error>, [src]

Skip elements on this stream while the provided asynchronous predicate resolves to true. Read more

ⓘImportant traits for TryForEachConcurrent<St, Fut, F>
fn try_for_each_concurrent<Fut, F, impl Into>>(
    self,
    limit: impl Into>,
    f: F
) -> TryForEachConcurrent<Self, Fut, F> where
    F: FnMut(Self::Ok) -> Fut,
    Fut: Future<Output = Result<(), Self::Error>>,
    impl Into>: Into<Option<usize>>, [src]

Attempts to run this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available, exiting as soon as an error occurs. Read more

ⓘImportant traits for TryCollect<St, C>
fn try_collect<C>(self) -> TryCollect<Self, C> where
    C: Default + Extend<Self::Ok>, [src]

Attempt to Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more

fn try_filter<Fut, F>(self, f: F) -> TryFilter<Self, Fut, F> where
    F: FnMut(&Self::Ok) -> Fut,
    Fut: Future<Output = bool>, [src]

Attempt to filter the values produced by this stream according to the provided asynchronous closure. Read more

fn try_filter_map<Fut, F, T>(self, f: F) -> TryFilterMap<Self, Fut, F> where
    F: FnMut(Self::Ok) -> Fut,
    Fut: TryFuture<Ok = Option<T>, Error = Self::Error>, [src]

Attempt to filter the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more

fn try_flatten(self) -> TryFlatten<Self> where
    Self::Ok: TryStream,
    <Self::Ok as TryStream>::Error: From<Self::Error>, [src]

Flattens a stream of streams into just one continuous stream. Read more

ⓘImportant traits for TryFold<St, Fut, T, F>
fn try_fold<T, Fut, F>(self, init: T, f: F) -> TryFold<Self, Fut, T, F> where
    F: FnMut(T, Self::Ok) -> Fut,
    Fut: TryFuture<Ok = T, Error = Self::Error>, [src]

Attempt to execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more

ⓘImportant traits for TryConcat<St>
fn try_concat(self) -> TryConcat<Self> where
    Self::Ok: Extend<<Self::Ok as IntoIterator>::Item>,
    Self::Ok: IntoIterator,
    Self::Ok: Default, [src]

Attempt to concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more

fn try_buffer_unordered(self, n: usize) -> TryBufferUnordered<Self> where
    Self::Ok: TryFuture,
    <Self::Ok as TryFuture>::Error == Self::Error, [src]

Attempt to execute several futures from a stream concurrently. Read more

fn try_poll_next_unpin(
    &mut self,
    cx: &mut Context
) -> Poll<Option<Result<Self::Ok, Self::Error>>> where
    Self: Unpin, [src]

A convenience method for calling [TryStream::try_poll_next] on [Unpin] stream types. Read more

impl<T, Item> SinkExt<Item> for T where
    T: Sink<Item> + ?Sized, [src]

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
    E: From<Self::Error>,
    F: FnMut(U) -> Fut,
    Fut: Future<Output = Result<Item, E>>, [src]

Composes a function in front of the sink. Read more

fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where
    F: FnMut(U) -> St,
    St: Stream<Item = Result<Item, Self::Error>>, [src]

Composes a function in front of the sink. Read more

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
    F: FnOnce(Self::Error) -> E, [src]

Transforms the error returned by the sink.

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
    Self::Error: Into<E>, [src]

Map this sink's error to a different error type using the Into trait. Read more

fn buffer(self, capacity: usize) -> Buffer<Self, Item>[src]

Adds a fixed-size buffer to the current sink. Read more

ⓘImportant traits for Close<'_, Si, Item>
fn close(&mut self) -> Close<Self, Item> where
    Self: Unpin, [src]

Close the sink.

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
    Item: Clone,
    Si: Sink<Item, Error = Self::Error>, [src]

Fanout items to multiple sinks. Read more

ⓘImportant traits for Flush<'_, Si, Item>
fn flush(&mut self) -> Flush<Self, Item> where
    Self: Unpin, [src]

Flush the sync, processing all pending items. Read more

ⓘImportant traits for Send<'_, Si, Item>
fn send(&mut self, item: Item) -> Send<Self, Item> where
    Self: Unpin, [src]

A future that completes after the given item has been fully processed into the sink, including flushing. Read more

ⓘImportant traits for SendAll<'_, Si, St>
fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
    Self: Unpin,
    St: Stream<Item = Item> + Unpin, [src]

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

ⓘImportant traits for Either<A, B>
fn left_sink<Si2>(self) -> Either<Self, Si2> where
    Si2: Sink<Item, Error = Self::Error>, [src]

Wrap this sink in an Either sink, making it the left-hand variant of that Either. Read more

ⓘImportant traits for Either<A, B>
fn right_sink<Si1>(self) -> Either<Si1, Self> where
    Si1: Sink<Item, Error = Self::Error>, [src]

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more