Struct pal_async::pipe::PolledPipe

pub struct PolledPipe { /* private fields */ }

A polled Unix pipe (or other pipe-like file).

Implementations

impl PolledPipe

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

Creates a polled pipe from a file.

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 get(&self) -> &File

Returns the inner file.

pub fn split(self) -> (ReadHalf, WriteHalf)

Splits the file into a read and write half that can be used concurrently.

This is more flexible and efficient than [futures::io::AsyncReadExt::split], since it avoids holding a lock while calling into the kernel, and it provides access to the underlying file for more advanced operations.

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>>

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>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl PollReady for PolledPipe

fn poll_ready( &mut self, cx: &mut Context<'_>, events: PollEvents, ) -> Poll<PollEvents>

Polls an object for readiness.