Struct LoopbackClientEnd 

pub struct LoopbackClientEnd { /* private fields */ }

The client half of a loopback duplex: the end an embedded caller holds.

Reads BLOCK (with an optional deadline), mirroring the SDK’s socket connection, whose reads are bounded by set_read_timeout and whose caller reads both WouldBlock and TimedOut as the same “no bytes in the window” answer. Writes never block: a full ring answers WouldBlock, exactly as a full socket send buffer does.

Implementations

impl LoopbackClientEnd

pub fn readable_bytes(&self) -> usize

Bytes already waiting for this end, consuming none of them.

pub fn read_timeout( &mut self, buf: &mut [u8], timeout: Option<Duration>, ) -> Result<usize>

Reads into buf, parking until bytes arrive, the server end is dropped, or timeout elapses. None parks without a deadline.

Ok(0) is end of file: the server end is gone and its ring is drained.

Errors

TimedOut when the window closes with no bytes and a live server end. The SDK’s socket path reads WouldBlock and TimedOut identically, so either satisfies its contract; TimedOut is the one that names what happened.

pub fn write_timeout( &mut self, buf: &[u8], timeout: Option<Duration>, ) -> Result<usize>

Writes from buf, parking until ring space appears, the server end is dropped, or timeout elapses. None parks without a deadline. Returns the accepted byte count, which may be short of buf.len().

This is the write-side twin of Self::read_timeout, and the socket it stands in for is why it exists. A blocking TcpStream with a write timeout BLOCKS while the kernel send buffer is full and fails only when the window closes, so write_all over a socket makes progress across a slow reader. Write::write on this end never blocks — a full ring answers WouldBlock at once, which io::Write::write_all reads as a hard failure — so a client driving the non-blocking half would see a backpressure semantics no other mount has. Both halves are kept: the non-blocking one is what the server end and the outbound budget want, this one is what a client’s write_all equivalent wants.

Errors

BrokenPipe when the server end has been dropped; TimedOut when the window closes with the ring still full.

Trait Implementations

impl Debug for LoopbackClientEnd

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

Formats the value using the given formatter.

impl Drop for LoopbackClientEnd

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 Read for LoopbackClientEnd

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

Blocks without a deadline. Callers that need one use LoopbackClientEnd::read_timeout.

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

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

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.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

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

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

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

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_, u8>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact( &mut self, cursor: BorrowedCursor<'_, u8>, ) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

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

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

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

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

fn read_le<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in little-endian order.

fn read_be<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in big-endian order.

impl Write for LoopbackClientEnd

fn flush(&mut self) -> Result<()>

Nothing buffers behind the ring, so a flush has nothing to push.

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

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

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

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

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.

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

Attempts to write an entire buffer into this writer.

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.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

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

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

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