Struct Selector

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

Available on crate feature select only.

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, F: FnMut(Result<(), SendError<U>>) -> T + 'a>( self, sender: &'a Sender<U>, msg: U, mapper: F, ) -> 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, F: FnMut(Result<U, RecvError>) -> T + 'a>( self, receiver: &'a Receiver<U>, mapper: F, ) -> 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 the eventual-fairness feature flag is enabled, this method is fair and will handle a random event of those that are ready.

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

Wait until one of the events associated with this Selector has completed or the timeout has expired. If the eventual-fairness feature flag is enabled, this method is fair and will handle a random event of those that are ready.

pub fn wait_deadline(self, deadline: Instant) -> Result<T, SelectError>

Wait until one of the events associated with this Selector has completed or the deadline has been reached. If the eventual-fairness feature flag is enabled, this method is fair and will handle a random event of those that are ready.

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.