Struct UnixFdStream 

pub struct UnixFdStream<T: AsRawFd> { /* private fields */ }

A wrapper around a UnixStream that allows file descriptors to be sent and received with messages. Implements AsyncRead and AsyncWrite such that standard asynchronous reading and writing operations and helpers may be used.

Implementations

impl<T: AsRawFd + NonBlocking> UnixFdStream<T>

pub fn new(unix: T, max_read_fds: usize) -> Result<Self>

Create a new UnixFdStream from a UnixStream which is also configured to read up to max_read_fds for each read from the socket.

The file descriptors that are transferred are buffered in a Vec<RawFd>, but only so many will have space made for them in the receiving header as configured by max_read_fds, other file descriptors sent beyond this limit will be discarded by the kernel. We do not check for the MSG_CTRUNC flag, therefore this will be a silent discard.

impl<T: AsRawFd> UnixFdStream<T>

pub fn split<'a>(&'a mut self) -> (ReadHalf<'a, T>, WriteHalf<'a, T>)

pub fn into_split(self) -> (OwnedReadHalf<T>, OwnedWriteHalf<T>)

pub fn push_outgoing_fd<F: IntoRawFd>(&self, fd: F)

Push a file descriptor to be written with the next message that is written to this stream. The ownership is transferred and the file descriptor is either closed when the message is sent or this instance is dropped.

pub async fn readable(&self) -> Result<()>

Wait for the underlying UnixStream to become readable.

pub fn pop_incoming_fd(&self) -> Option<RawFd>

Get the most recent file descriptor that was read with a message.

pub fn incoming_count(&self) -> usize

Get the number of file descriptors in the incoming queue.

Trait Implementations

impl<T: AsRawFd> AsyncRead for UnixFdStream<T>

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl<T: AsRawFd + Shutdown + Unpin> AsyncWrite for UnixFdStream<T>

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

Attempt to write bytes from buf into the object.

fn poll_flush( self: Pin<&mut Self>, _cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut Self>, _cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

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

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<T: AsRawFd> Drop for UnixFdStream<T>

fn drop(&mut self)

Executes the destructor for this type.