Struct Stream

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

A stream represents a bidirectional or unidirectional stream.

Implementations

impl Stream

pub fn id(&self) -> Option<u64>

Returns the stream ID.

pub fn split(self) -> (Option<ReadStream>, Option<WriteStream>)

Splits the stream into a read stream and a write stream.

pub fn poll_read( &mut self, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize, ReadError>>

Poll to read from the stream into buf.

pub fn poll_read_chunk( &self, cx: &mut Context<'_>, ) -> Poll<Result<Option<StreamRecvBuffer>, ReadError>>

Poll to read the next segment of data.

pub fn read_chunk(&self) -> ReadChunk<'_>

Read the next segment of data.

pub fn poll_write( &mut self, cx: &mut Context<'_>, buf: &[u8], fin: bool, ) -> Poll<Result<usize, WriteError>>

Poll to write to the stream from buf.

pub fn poll_write_chunk( &mut self, cx: &mut Context<'_>, chunk: &Bytes, fin: bool, ) -> Poll<Result<usize, WriteError>>

Poll to write a bytes to the stream directly.

pub fn write_chunk<'a>( &'a mut self, chunk: &'a Bytes, fin: bool, ) -> WriteChunk<'a>

Write a bytes to the stream directly.

pub fn poll_write_chunks( &mut self, cx: &mut Context<'_>, chunks: &[Bytes], fin: bool, ) -> Poll<Result<usize, WriteError>>

Poll to write the list of bytes to the stream directly.

pub fn write_chunks<'a>( &'a mut self, chunks: &'a [Bytes], fin: bool, ) -> WriteChunks<'a>

Write the list of bytes to the stream directly.

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

Poll to finish writing to the stream.

pub fn poll_abort_write( &mut self, cx: &mut Context<'_>, error_code: u64, ) -> Poll<Result<(), WriteError>>

Poll to abort writing to the stream.

pub fn abort_write(&mut self, error_code: u64) -> Result<(), WriteError>

Abort writing to the stream.

pub fn poll_abort_read( &mut self, cx: &mut Context<'_>, error_code: u64, ) -> Poll<Result<(), ReadError>>

Poll to abort reading from the stream.

pub fn abort_read(&mut self, error_code: u64) -> Result<(), ReadError>

Abort reading from the stream.

Trait Implementations

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 AsyncRead for Stream

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

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

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 poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

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

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

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<()>>

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

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

Attempt to close the object.

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

Attempt to write bytes from bufs into the object using vectored IO operations.

impl Debug for Stream

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

Formats the value using the given formatter.