Struct stream_multiplexer::Multiplexer

pub struct Multiplexer<St, Si> where
    St: 'static,  { /* fields omitted */ }

Implementations

impl<St, Si> Multiplexer<St, Si> where
    St: TryStream + Unpin,
    St::Ok: Clone,
    Si: Sink<St::Ok> + Unpin,
    Si::Error: Debug, 

pub fn new() -> Self

Creates a Multiplexer

pub fn add_channel(
    &mut self,
    channel_id: ChannelId
) -> Result<(), MultiplexerError<Si::Error>>

Adds a channel id to the internal table used for validation checks.

Returns an error if channel already exists.

pub fn has_channel(&self, channel: ChannelId) -> bool

Returns true if the channel id exists.

pub fn remove_channel(&mut self, channel: ChannelId) -> bool

Removes a channel.

Returns true if found, false otherwise.

pub async fn send<'_>(
    &'_ self,
    stream_ids: impl IntoIterator<Item = StreamId>,
    data: St::Ok
) -> Vec<Result<StreamId, MultiplexerError<Si::Error>>>

Sends data to a set of stream_ids, waiting for them to be sent.

pub fn add_stream_pair(
    &mut self,
    sink: Si,
    stream: St,
    channel_id: ChannelId
) -> Result<StreamId, MultiplexerError<Si::Error>>

Adds stream to the channel and stores sink.

Returns a StreamId that represents the pair. It can be used in functions such as send() or change_stream_channel().

pub fn change_stream_channel(
    &self,
    stream_id: StreamId,
    channel_id: ChannelId
) -> Result<(), MultiplexerError<Si::Error>>

Signals to the stream that it should move to a given channel.

The channel change is not instantaneous. Calling .recv() on the stream's current channel may result in that channel receiving more of the stream's data.

pub fn remove_stream(&mut self, stream_id: StreamId) -> bool

Removes the stream from the multiplexer

pub async fn recv<'_>(
    &'_ mut self,
    channel_id: ChannelId
) -> Result<(StreamId, Option<St::Item>), MultiplexerError<Si::Error>>

Receives the next packet available from a channel:

Returns a tuple of the stream's ID and it's data or an error.

Trait Implementations

impl<St, Si> Clone for Multiplexer<St, Si>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<St: Debug, Si: Debug> Debug for Multiplexer<St, Si> where
    St: 'static, 

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.