Struct SelectedOperation

#[must_use]
pub struct SelectedOperation<'a> { /* private fields */ }

A selected operation that needs to be completed.

To complete the operation, call send or recv.

Panics

Forgetting to complete the operation is an error and might lead to deadlocks. If a SelectedOperation is dropped without completion, a panic occurs.

Implementations

impl SelectedOperation<'_>

fn index(&self) -> usize

Returns the index of the selected operation.

Examples

use crossbeam_channel::{bounded, Select};

let (s1, r1) = bounded::<()>(0);
let (s2, r2) = bounded::<()>(0);
let (s3, r3) = bounded::<()>(1);

let mut sel = Select::new();
let oper1 = sel.send(&s1);
let oper2 = sel.recv(&r2);
let oper3 = sel.send(&s3);

// Only the last operation is ready.
let oper = sel.select();
assert_eq!(oper.index(), 2);
assert_eq!(oper.index(), oper3);

// Complete the operation.
oper.send(&s3, ()).unwrap();
fn send<T>(self, s: &Sender<T>, msg: T) -> Result<(), SendError<T>>

Completes the send operation.

The passed Sender reference must be the same one that was used in Select::send when the operation was added.

Panics

Panics if an incorrect Sender reference is passed.

Examples

use crossbeam_channel::{bounded, Select, SendError};

let (s, r) = bounded::<i32>(0);
drop(r);

let mut sel = Select::new();
let oper1 = sel.send(&s);

let oper = sel.select();
assert_eq!(oper.index(), oper1);
assert_eq!(oper.send(&s, 10), Err(SendError(10)));
fn recv<T>(self, r: &Receiver<T>) -> Result<T, RecvError>

Completes the receive operation.

The passed Receiver reference must be the same one that was used in Select::recv when the operation was added.

Panics

Panics if an incorrect Receiver reference is passed.

Examples

use crossbeam_channel::{bounded, Select, RecvError};

let (s, r) = bounded::<i32>(0);
drop(s);

let mut sel = Select::new();
let oper1 = sel.recv(&r);

let oper = sel.select();
assert_eq!(oper.index(), oper1);
assert_eq!(oper.recv(&r), Err(RecvError));

Trait Implementations

impl Debug for SelectedOperation<'_>

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

impl Drop for SelectedOperation<'_>

fn drop(&mut self)

Auto Trait Implementations

impl<'a> !Send for SelectedOperation<'a>

impl<'a> !Sync for SelectedOperation<'a>

impl<'a> Freeze for SelectedOperation<'a>

impl<'a> RefUnwindSafe for SelectedOperation<'a>

impl<'a> Unpin for SelectedOperation<'a>

impl<'a> UnsafeUnpin for SelectedOperation<'a>

impl<'a> UnwindSafe for SelectedOperation<'a>

Blanket Implementations

impl<T> Any for SelectedOperation<'a> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for SelectedOperation<'a> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for SelectedOperation<'a> where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for SelectedOperation<'a>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for SelectedOperation<'a> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for SelectedOperation<'a> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for SelectedOperation<'a> where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>