Struct DuplexStream 

pub struct DuplexStream { /* private fields */ }

An endpoint owns both half-streams. Share it with Arc; dropping the last owner releases buffers and wakes both ends. A cancelled operation transfers no bytes; a successful write transfers the entire chunk atomically.

Implementations

impl DuplexStream

pub fn pair( capacity_per_direction: usize, ) -> Result<(Arc<Self>, Arc<Self>), Error>

pub async fn read( &self, max: usize, cancel: &CancelToken, ) -> Result<Vec<u8>, Error>

pub async fn write( &self, bytes: &[u8], cancel: &CancelToken, ) -> Result<(), Error>

pub fn shutdown_write(&self)

Half-close: the peer drains queued bytes, then reads EOF. Receive stays open.

pub fn release(&self)

Full release: discard queues and fail all parked operations, at both ends.

pub fn readiness(&self) -> StreamReadiness

Advisory snapshot; another consumer may change readiness before an operation.

pub async fn ready( &self, read: bool, write: bool, cancel: &CancelToken, ) -> Result<StreamReadiness, Error>

Wait for receive data/EOF or transmit capacity. Specify only interests needed by the caller; writable sockets usually become ready immediately.

pub fn store(self: &Arc<Self>) -> StreamStore

Mount this endpoint through the standard consuming stream protocol.

Trait Implementations

impl Drop for DuplexStream

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.