Struct Mux

pub struct Mux { /* private fields */ }

A Mux provides a single receive end and multiple send ends. Data sent to any of the send ends comes out the receive end, in order, tagged by the sender.

Mux implements AsFd solely to support polling the underlying file descriptor for data to read. Always use Mux to perform the actual read.

Implementations

impl Mux

pub fn new_abstract() -> Result<Self>

Create a new Mux, using Linux abstract sockets.

pub fn new() -> Result<Self>

Create a new Mux.

This will create a temporary directory for all the sockets managed by this Mux; dropping the Mux removes the temporary directory.

pub fn new_in<P: AsRef<Path>>(dir: P) -> Result<Self>

Create a new Mux, with temporary directory under the specified path.

This will create a temporary directory for all the sockets managed by this Mux; dropping the Mux removes the temporary directory.

pub fn make_sender(&self) -> Result<(Tag, MuxSender)>

Create a new MuxSender and associated unique Tag. Data sent via the returned MuxSender will arrive with the corresponding Tag.

pub fn read<'mux>(&'mux mut self) -> Result<TaggedData<'mux>>

Return the next chunk of data, together with its tag.

This reuses a buffer managed by the Mux.

Note that this provides no “EOF” indication; if no further data arrives, it will block forever. Avoid calling it after the source of the data exits.

Trait Implementations

impl AsFd for Mux

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for Mux

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.