Struct PolledPipe

pub struct PolledPipe { /* private fields */ }

A Windows pipe, configured for polled IO.

Implementations

impl PolledPipe

pub fn new(driver: &(impl ?Sized + Driver), file: File) -> Result<Self>

Configures a pipe file for polled use.

Due to platform limitations, this will fail for unidirectional pipes on older versions of Windows and on unbuffered pipes.

pub fn pair(driver: &(impl ?Sized + Driver)) -> Result<(Self, Self)>

Creates a connected pair of polled pipes, returning (read pipe, write pipe).

pub fn file_pair() -> Result<(File, File)>

Creates a connected pair of pipes (read pipe, write pipe) suitable for passing to Self::new.

pub fn into_inner(self) -> File

Returns the inner pipe file.

pub fn poll_closing(&mut self, cx: &mut Context<'_>) -> Poll<Result<()>>

Polls the pipe for entering the closing state, where the client has closed its handle.

Trait Implementations

impl AsyncRead for PolledPipe

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 PolledPipe

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.