Struct Framed 

pub struct Framed<R, W, C, F, In, Out> { /* private fields */ }

Available on crate feature io only.

A framed encoder/decoder that handles both Sink for writing frames and Stream for reading frames.

It uses a codec to encode/decode messages into frames (T -> Vec<u8>) and a Framer to define how frames are laid out in buffer (&mut [u8] -> &mut [u8]).

Implementations

impl<R, W, C, F, In, Out> Framed<R, W, C, F, In, Out>

pub fn with_reader<Io>(self, reader: Io) -> Framed<Io, W, C, F, In, Out>

Change the reader of the Framed object.

pub fn with_writer<Io>(self, writer: Io) -> Framed<R, Io, C, F, In, Out>

Change the writer of the Framed object.

pub fn with_duplex<Io>( self, io: Io, ) -> Framed<<Io as Splittable>::ReadHalf, <Io as Splittable>::WriteHalf, C, F, In, Out>

where Io: Splittable,

Change the codec of the Framed object.

This is useful when you have a duplex I/O type, e.g., a compio::net::TcpStream or compio::fs::File, and you want Framed to implement both Sink and Stream.

Some types like the ones mentioned above are multiplexed by nature, so they implement the Splittable trait by themselves. For other types, you may want to wrap them in Split first, which uses lock or RefCell under the hood.

impl<C, F> Framed<(), (), C, F, (), ()>

pub fn new<In, Out>(codec: C, framer: F) -> Framed<(), (), C, F, In, Out>

Creates a new Framed with the given I/O object, codec, framer and a different input and output type.

pub fn symmetric<T>(codec: C, framer: F) -> Framed<(), (), C, F, T, T>

Creates a new Framed with the given I/O object, codec, and framer with the same input and output type.

Trait Implementations

impl<R, W, C, F, In, Out> Sink<In> for Framed<R, W, C, F, In, Out>

where W: AsyncWrite + 'static, C: Encoder<In>, F: Framer, Framed<R, W, C, F, In, Out>: Unpin,

type Error = <C as Encoder<In>>::Error

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

fn poll_ready( self: Pin<&mut Framed<R, W, C, F, In, Out>>, cx: &mut Context<'_>, ) -> Poll<Result<(), <Framed<R, W, C, F, In, Out> as Sink<In>>::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut Framed<R, W, C, F, In, Out>>, item: In, ) -> Result<(), <Framed<R, W, C, F, In, Out> as Sink<In>>::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Framed<R, W, C, F, In, Out>>, cx: &mut Context<'_>, ) -> Poll<Result<(), <Framed<R, W, C, F, In, Out> as Sink<In>>::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Framed<R, W, C, F, In, Out>>, cx: &mut Context<'_>, ) -> Poll<Result<(), <Framed<R, W, C, F, In, Out> as Sink<In>>::Error>>

Flush any remaining output and close this sink, if necessary.

impl<R, W, C, F, In, Out> Stream for Framed<R, W, C, F, In, Out>

where R: AsyncRead + 'static, C: Decoder<Out>, F: Framer, Framed<R, W, C, F, In, Out>: Unpin,

type Item = Result<Out, <C as Decoder<Out>>::Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Framed<R, W, C, F, In, Out>>, cx: &mut Context<'_>, ) -> Poll<Option<<Framed<R, W, C, F, In, Out> as Stream>::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.