Struct IoTest 

pub struct IoTest { /* private fields */ }

One endpoint of an in-memory asynchronous byte stream.

Use IoTest::create to construct connected client and server endpoints. Bytes written by one endpoint become readable from the other.

Implementations

impl IoTest

pub fn create() -> (IoTest, IoTest)

Creates connected client and server endpoints.

pub fn is_client_dropped(&self) -> bool

Returns true after the client endpoint has been dropped.

pub fn is_server_dropped(&self) -> bool

Returns true after the server endpoint has been dropped.

pub fn is_closed(&self) -> bool

Returns true after the peer has closed its write side.

pub fn set_peer_addr(self, addr: SocketAddr) -> Self

Sets the socket address returned by transport queries.

pub fn read_pending(&self)

Forces subsequent reads from the peer endpoint to remain pending.

pub fn read_error(&self, err: Error)

Makes the peer endpoint’s next read fail with err.

pub fn write_error(&self, err: Error)

Makes the peer endpoint’s next transport write fail with err.

pub fn write_zero(&self)

Makes the peer endpoint’s next transport write return zero bytes.

pub fn local_buffer<F, R>(&self, f: F) -> R

where F: FnOnce(&mut BytesMut) -> R,

Provides mutable access to bytes readable by this endpoint.

pub fn remote_buffer<F, R>(&self, f: F) -> R

where F: FnOnce(&mut BytesMut) -> R,

Provides mutable access to bytes readable by the peer endpoint.

pub async fn close(&self)

Simulates this endpoint closing its write side.

This wakes the peer endpoint’s pending reader and waits briefly so the close can be observed by asynchronous test code.

pub fn write<T: AsRef<[u8]>>(&self, data: T)

Writes bytes for the peer endpoint to read and wakes its reader.

pub fn remote_buffer_cap(&self, cap: usize)

Sets how many bytes the peer may write before becoming blocked.

Increasing the capacity wakes the peer’s pending writer.

pub fn read_any(&self) -> Bytes

Takes all bytes currently readable by this endpoint without waiting.

pub async fn read(&self) -> Result<Bytes, Error>

Waits for readable data or peer closure, then takes all available bytes.

pub fn poll_read_buf( &self, cx: &mut Context<'_>, buf: &mut BytesMut, ) -> Poll<Result<usize>>

Polls a transport read into buf.

Returns the number of bytes copied, zero on simulated peer closure, or Pending when no input is available.

Panics

Panics if data is available but buf has no remaining capacity.

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

Polls a transport write from buf.

The write is limited by the capacity configured with remote_buffer_cap.

Trait Implementations

impl Clone for IoTest

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IoTest

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

Formats the value using the given formatter.

impl Drop for IoTest

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl IoStream for IoTest

fn start(self, ctx: IoContext) -> Box<dyn Handle>

Starts transport-specific I/O tasks and returns their control handle.