Struct DtactStream 

pub struct DtactStream { /* private fields */ }

One end of an in-process duplex pipe. Create a connected pair with pair.

Implementations

impl DtactStream

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

Non-blocking poll-based read, usable directly from a hand-rolled Future or via the async fn read convenience below.

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

Non-blocking poll-based write.

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

Read into buf, returning the number of bytes read (0 = EOF).

Errors

Returns io::ErrorKind::BrokenPipe if the peer’s write half has been dropped with no more buffered bytes to deliver (analogous to EOF on a real pipe, surfaced as Ok(0) in that case — see poll_read’s implementation — so in practice this async wrapper itself only ever returns Ok; the Result exists for symmetry with write/write_all and to leave room for future error paths).

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

Write from buf, returning the number of bytes written.

Errors

Returns io::ErrorKind::BrokenPipe if the peer has dropped its read half — there is no reader left to ever drain the queue, so the write can never succeed.

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

Write the entirety of buf, retrying partial writes.

Errors

Returns the same io::ErrorKind::BrokenPipe as Self::write if the peer drops its read half partway through.

Trait Implementations

impl Drop for DtactStream

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 Send for DtactStream

impl Sync for DtactStream