Struct flume::select::Selector

pub struct Selector<'a, T: 'a> { /* fields omitted */ }

A type used to wait upon multiple blocking operations at once.

A Selector implements select-like behaviour, allowing a thread to wait upon the result of more than one operation at once.

Examples

let (tx0, rx0) = flume::unbounded();
let (tx1, rx1) = flume::unbounded();

std::thread::spawn(move || {
    tx0.send(true).unwrap();
    tx1.send(42).unwrap();
});

flume::Selector::new()
    .recv(&rx0, |b| println!("Received {:?}", b))
    .recv(&rx1, |n| println!("Received {:?}", n))
    .wait();

Implementations

impl<'a, T> Selector<'a, T>

pub fn new() -> Self

Create a new selector.

pub fn send<U>(
    self,
    sender: &'a Sender<U>,
    msg: U,
    mapper: impl FnMut(Result<(), SendError<U>>) -> T + 'a
) -> Self

Add a send operation to the selector that sends the provided value.

Once added, the selector can be used to run the provided handler function on completion of this operation.

pub fn recv<U>(
    self,
    receiver: &'a Receiver<U>,
    mapper: impl FnMut(Result<U, RecvError>) -> T + 'a
) -> Self

Add a receive operation to the selector.

Once added, the selector can be used to run the provided handler function on completion of this operation.

pub fn wait(self) -> T

Wait until one of the events associated with this Selector has completed. If more than one event has completed, a random event handler will be run and its return value produced.

pub fn wait_timeout(self, dur: Duration) -> T

Wait until one of the events associated with this Selector has completed or the timeout has been reached. If more than one event has completed, a random event handler will be run and its return value produced.

Trait Implementations

impl<'a, T: 'a> Debug for Selector<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: 'a> Default for Selector<'a, T>

fn default() -> Self

Returns the "default value" for a type.