Struct websocket::sync::stream::ReadWritePair

[+] Show declaration

pub struct ReadWritePair<R, W>(pub R, pub W)
 where
    R: Read,
    W: Write;

[−] Expand description

If you would like to combine an input stream and an output stream into a single stream to talk websockets over then this is the struct for you!

This is useful if you want to use different mediums for different directions.

Trait Implementations

impl<R, W> AsyncRead for ReadWritePair<R, W> where
    R: AsyncRead,
    W: Write, [+]

[+] Show hidden undocumented items

pub unsafe fn prepare_uninitialized_buffer(&self, buf: &mut [u8]) -> bool[−]

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

pub fn poll_read(&mut self, buf: &mut [u8]) -> Result<Async<usize>, Error>[−]

Attempt to read from the AsyncRead into buf.

pub fn read_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
    B: BufMut, [−]

Pull some bytes from this source into the specified BufMut, returning how many bytes were read.

pub fn framed<T>(self, codec: T) -> Framed<Self, T> where
    Self: AsyncWrite,
    T: Encoder + Decoder, [−]

👎 Deprecated since 0.1.7:

Use tokio_codec::Decoder::framed instead

Provides a Stream and Sink interface for reading and writing to this I/O object, using Decode and Encode to read and write the raw data.

pub fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
    Self: AsyncWrite, [−]

Helper method for splitting this read/write object into two halves.

impl<R, W> AsyncWrite for ReadWritePair<R, W> where
    R: Read,
    W: AsyncWrite, [+]

[+] Show hidden undocumented items

pub fn shutdown(&mut self) -> Result<Async<()>, Error>[−]

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

pub fn poll_write(&mut self, buf: &[u8]) -> Result<Async<usize>, Error>[−]

Attempt to write bytes from buf into the object.

pub fn poll_flush(&mut self) -> Result<Async<()>, Error>[−]

Attempt to flush the object, ensuring that any buffered data reach their destination.

pub fn write_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
    B: Buf, [−]

Write a Buf into this value, returning how many bytes were written.

impl<R, W> Read for ReadWritePair<R, W> where
    R: Read,
    W: Write, [+]

[+] Show hidden undocumented items

pub fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>[−]

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>[−]

Read all bytes until EOF in this source, placing them into buf.

pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>[−]

Read all bytes until EOF in this source, appending them to buf.

pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>[−]

Read the exact number of bytes required to fill buf.

pub fn read_vectored(
    &mut self,
    bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>[−]

Like read, except that it reads into a slice of buffers.

pub fn is_read_vectored(&self) -> bool[−]

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

pub unsafe fn initializer(&self) -> Initializer[−]

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

pub fn by_ref(&mut self) -> &mut Self[−]

Creates a “by reference” adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>[−]

Transforms this Read instance to an Iterator over its bytes.

pub fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, [−]

Creates an adaptor which will chain this stream with another.

pub fn take(self, limit: u64) -> Take<Self>[−]

Creates an adaptor which will read at most limit bytes from it.

impl<R, W> Splittable for ReadWritePair<R, W> where
    R: Read,
    W: Write, [+]

[+] Show hidden undocumented items

type Reader = R

The reading component of this type

type Writer = W

The writing component of this type

pub fn split(self) -> Result<(R, W), Error>[−]

Split apart this type into a reading and writing component.

impl<R, W> Write for ReadWritePair<R, W> where
    R: Read,
    W: Write, [+]

[+] Show hidden undocumented items

pub fn write(&mut self, buf: &[u8]) -> Result<usize, Error>[−]

Write a buffer into this writer, returning how many bytes were written.

pub fn flush(&mut self) -> Result<(), Error>[−]

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>[−]

Attempts to write an entire buffer into this writer.

pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>[−]

Writes a formatted string into this writer, returning any error encountered.

pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>[−]

Like write, except that it writes from a slice of buffers.

pub fn is_write_vectored(&self) -> bool[−]

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

pub fn write_all_vectored(
    &mut self,
    bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>[−]

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

pub fn by_ref(&mut self) -> &mut Self[−]

Creates a “by reference” adaptor for this instance of Write.