Struct Stream 

pub struct Stream(/* private fields */);

Cross platform bidirectional stream that implements AsyncRead and AsyncWrite.

Implementations

impl Stream

pub async fn async_io<R>( &self, interest: Interest, f: impl FnMut() -> Result<R>, ) -> Result<R>

Reads or writes from the stream using a user-provided IO operation.

See UnixStream::async_io.

pub async fn readable(&self) -> Result<()>

Waits for the stream to become readable.

See UnixStream::readable.

pub async fn ready(&self, interest: Interest) -> Result<Ready>

Waits for any of the requested ready states.

See UnixStream::ready.

pub fn poll_read_ready(&self, cx: &mut Context<'_>) -> Poll<Result<()>>

Polls for read readiness.

See UnixStream::poll_read_ready.

pub fn try_io<R>( &self, interest: Interest, f: impl FnOnce() -> Result<R>, ) -> Result<R>

Tries to read or write from the socket using a user-provided IO operation.

See UnixStream::try_io.

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

Try to read data from the stream into the provided buffer, returning how many bytes were read.

See UnixStream::try_read.

pub fn try_read_buf<B: BufMut>(&self, buf: &mut B) -> Result<usize>

Tries to read data from the stream into the provided buffer, advancing the buffer’s internal cursor, returning how many bytes were read.

See UnixStream::try_read_buf.

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

Tries to read data from the stream into the provided buffers, returning how many bytes were read.

See UnixStream::try_read_vectored.

pub async fn writable(&self) -> Result<()>

Waits for the stream to become writable.

See UnixStream::writable.

pub fn poll_write_ready(&self, cx: &mut Context<'_>) -> Poll<Result<()>>

Polls for write readiness.

See UnixStream::poll_write_ready.

pub fn try_write(&self, buf: &[u8]) -> Result<usize>

Tries to write a buffer to the stream, returning how many bytes were written.

See UnixStream::try_write.

pub fn try_write_vectored(&self, buf: &[IoSlice<'_>]) -> Result<usize>

Tries to write several buffers to the stream, returning how many bytes were written.

See UnixStream::try_write_vectored.

Trait Implementations

impl AsFd for Stream

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for Stream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsyncRead for Stream

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl AsyncWrite for Stream

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

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

fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

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

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[IoSlice<'_>], ) -> Poll<Result<usize>>

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