Struct io_mux::Mux

pub struct Mux { /* fields omitted */ }

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.

Methods

impl Mux

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 make_untagged_sender(&self) -> Result<MuxSender>

Create a new MuxSender with no tag. Data sent via this MuxSender will arrive with a tag of None.

pub fn make_tagged_sender(&self, tag: &str) -> Result<MuxSender>

Create a new MuxSender with the specified tag. Data sent via this MuxSender will arrive with a tag of Some(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.