Struct futures_ringbuf::Endpoint

pub struct Endpoint { /* private fields */ }

Represents a network endpoint. This is for duplex connection mocking. Each direction has a separate ringbuffer and one buffer’s readhalf is connected to the other buffer’s writehalf in order to simulate a duplex connection.

The main way to create this is to call Endpoint::pair which returns a tuple of endpoints, and which let’s you specify the buffer size for each direction.

Endpoint implements AsyncRead/AsyncWrite so you can feed it to interfaces that need those combined in a single type.

By setting the buffer size precisely, one can simulate back pressure. Endpoint will return Pending on writes when full and on reads when empty.

When calling close on an endpoint, any further writes on that endpoint will return std::io::ErrorKind::NotConnected and any reads on the other endpoint will continue to empty the buffer and then return Ok(0). Ok(0) means no new data will ever appear, unless you passed in a zero sized buffer.

If the remote endpoint is pending on a read, the task will be woken up when calling close or dropping this endpoint.

Implementations

impl Endpoint

pub fn pair(a_buf: usize, b_buf: usize) -> (Endpoint, Endpoint)

Create a pair of endpoints, specifying the buffer size for each one. The buffer size corresponds to the buffer the respective endpoint writes to. The other will read from this one.

Trait Implementations

impl AsyncRead for Endpoint

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 Endpoint

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 Endpoint

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

Formats the value using the given formatter.

impl Drop for Endpoint

Makes sure that the reader of the other end is notified (woken up if pending) of the connection closure.

fn drop(&mut self)

Executes the destructor for this type.