Struct tokio_uds::UnixDatagramFramed

pub struct UnixDatagramFramed<A, C> { /* private fields */ }

A unified Stream and Sink interface to an underlying UnixDatagram, using the Encoder and Decoder traits to encode and decode frames.

Unix datagram sockets work with datagrams, but higher-level code may 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 UnixDatagramFramed returned by this method, which will break them into separate objects, allowing them to interact more easily.

Implementations

impl<A, C> UnixDatagramFramed<A, C>

pub fn new(socket: UnixDatagram, codec: C) -> UnixDatagramFramed<A, C>

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

See struct level documentation for more details.

pub fn get_ref(&self) -> &UnixDatagram

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 UnixDatagram

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.

Trait Implementations

impl<A: Debug, C: Debug> Debug for UnixDatagramFramed<A, C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<A: AsRef<Path>, C: Encoder> Sink for UnixDatagramFramed<A, C>

type SinkItem = (<C as Encoder>::Item, A)

The type of value that the sink accepts.

type SinkError = <C as Encoder>::Error

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

fn start_send(
    &mut self,
    item: Self::SinkItem
) -> StartSend<Self::SinkItem, Self::SinkError>

Begin the process of sending a value to the sink.

fn poll_complete(&mut self) -> Poll<(), C::Error>

Flush all output from this sink, if necessary.

fn close(&mut self) -> Poll<(), C::Error>

A method to indicate that no more values will ever be pushed into this sink.

fn wait(self) -> Wait<Self>where
    Self: Sized,

Creates a new object which will produce a synchronous sink.

fn with<U, F, Fut>(self, f: F) -> With<Self, U, F, Fut>where
    F: FnMut(U) -> Fut,
    Fut: IntoFuture<Item = Self::SinkItem>,
    <Fut as IntoFuture>::Error: From<Self::SinkError>,
    Self: Sized,

Composes a function in front of the sink.

fn with_flat_map<U, F, St>(self, f: F) -> WithFlatMap<Self, U, F, St>where
    F: FnMut(U) -> St,
    St: Stream<Item = Self::SinkItem, Error = Self::SinkError>,
    Self: Sized,

Composes a function in front of the sink.

fn sink_map_err<F, E>(self, f: F) -> SinkMapErr<Self, F>where
    F: FnOnce(Self::SinkError) -> E,
    Self: Sized,

Transforms the error returned by the sink.

fn sink_from_err<E>(self) -> SinkFromErr<Self, E>where
    E: From<Self::SinkError>,
    Self: Sized,

Map this sink’s error to any error implementing From for this sink’s Error, returning a new sink.

fn buffer(self, amt: usize) -> Buffer<Self>where
    Self: Sized,

Adds a fixed-size buffer to the current sink.

fn flush(self) -> Flush<Self>where
    Self: Sized,

A future that completes when the sink has finished processing all pending requests.

fn send(self, item: Self::SinkItem) -> Send<Self>where
    Self: Sized,

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

fn send_all<S>(self, stream: S) -> SendAll<Self, S>where
    S: Stream<Item = Self::SinkItem>,
    Self::SinkError: From<<S as Stream>::Error>,
    Self: Sized,

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

impl<A, C: Decoder> Stream for UnixDatagramFramed<A, C>

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

The type of item this stream will yield on success.

type Error = <C as Decoder>::Error

The type of error this stream may generate.

fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error>

Attempt to pull out the next value of this stream, returning None if the stream is finished.

fn wait(self) -> Wait<Self>where
    Self: Sized,

Creates an iterator which blocks the current thread until each item of this stream is resolved.

fn into_future(self) -> StreamFuture<Self>where
    Self: Sized,

Converts this stream into a Future.

fn map<U, F>(self, f: F) -> Map<Self, F>where
    F: FnMut(Self::Item) -> U,
    Self: Sized,

Converts a stream of type T to a stream of type U.

fn map_err<U, F>(self, f: F) -> MapErr<Self, F>where
    F: FnMut(Self::Error) -> U,
    Self: Sized,

Converts a stream of error type T to a stream of error type U.

fn filter<F>(self, f: F) -> Filter<Self, F>where
    F: FnMut(&Self::Item) -> bool,
    Self: Sized,

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

fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F>where
    F: FnMut(Self::Item) -> Option<B>,
    Self: Sized,

Filters the values produced by this stream while simultaneously mapping them to a different type.

fn then<F, U>(self, f: F) -> Then<Self, F, U>where
    F: FnMut(Result<Self::Item, Self::Error>) -> U,
    U: IntoFuture,
    Self: Sized,

Chain on a computation for when a value is ready, passing the resulting item to the provided closure f.

fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U>where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Error = Self::Error>,
    Self: Sized,

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

fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U>where
    F: FnMut(Self::Error) -> U,
    U: IntoFuture<Item = Self::Item>,
    Self: Sized,

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

fn collect(self) -> Collect<Self>where
    Self: Sized,

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

fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T>where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: IntoFuture<Item = T>,
    Self::Error: From<<Fut as IntoFuture>::Error>,
    Self: Sized,

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

fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R>where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>,
    Self: Sized,

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

fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R>where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>,
    Self: Sized,

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

fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U>where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Item = (), Error = Self::Error>,
    Self: Sized,

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

fn from_err<E>(self) -> FromErr<Self, E>where
    E: From<Self::Error>,
    Self: Sized,

Map this stream’s error to any error implementing From for this stream’s Error, returning a new stream.

fn take(self, amt: u64) -> Take<Self>where
    Self: Sized,

Creates a new stream of at most amt items of the underlying stream.

fn skip(self, amt: u64) -> Skip<Self>where
    Self: Sized,

Creates a new stream which skips amt items of the underlying stream.

fn fuse(self) -> Fuse<Self>where
    Self: Sized,

Fuse a stream such that poll will never again be called once it has finished.

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

Borrows a stream, rather than consuming it.

fn merge<S>(self, other: S) -> Merge<Self, S>where
    S: Stream<Error = Self::Error>,
    Self: Sized,

👎Deprecated: functionality provided by select now

An adapter for merging the output of two streams.

fn zip<S>(self, other: S) -> Zip<Self, S>where
    S: Stream<Error = Self::Error>,
    Self: Sized,

An adapter for zipping two streams together.

fn chain<S>(self, other: S) -> Chain<Self, S>where
    S: Stream<Item = Self::Item, Error = Self::Error>,
    Self: Sized,

Adapter for chaining two stream.

fn peekable(self) -> Peekable<Self>where
    Self: Sized,

Creates a new stream which exposes a peek method.

fn chunks(self, capacity: usize) -> Chunks<Self>where
    Self: Sized,

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

fn select<S>(self, other: S) -> Select<Self, S>where
    S: Stream<Item = Self::Item, Error = Self::Error>,
    Self: Sized,

Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first.

fn forward<S>(self, sink: S) -> Forward<Self, S>where
    S: Sink<SinkItem = Self::Item>,
    Self::Error: From<<S as Sink>::SinkError>,
    Self: Sized,

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

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

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

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

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