use core::future::Future; use core::pin::Pin; use core::task::{Context, Poll}; /// Result for [`select`]. #[derive(Debug, Clone)] #[cfg_attr(feature = "defmt", derive(defmt::Format))] pub enum Either { /// First future finished first. First(A), /// Second future finished first. Second(B), } /// Wait for one of two futures to complete. /// /// This function returns a new future which polls all the futures. /// When one of them completes, it will complete with its result value. /// /// The other future is dropped. pub fn select(a: A, b: B) -> Select where A: Future, B: Future, { Select { a, b } } /// Future for the [`select`] function. #[derive(Debug)] #[must_use = "futures do nothing unless you `.await` or poll them"] pub struct Select { a: A, b: B, } impl Unpin for Select {} impl Future for Select where A: Future, B: Future, { type Output = Either; fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll { let this = unsafe { self.get_unchecked_mut() }; let a = unsafe { Pin::new_unchecked(&mut this.a) }; let b = unsafe { Pin::new_unchecked(&mut this.b) }; if let Poll::Ready(x) = a.poll(cx) { return Poll::Ready(Either::First(x)); } if let Poll::Ready(x) = b.poll(cx) { return Poll::Ready(Either::Second(x)); } Poll::Pending } } // ==================================================================== /// Result for [`select3`]. #[derive(Debug, Clone)] #[cfg_attr(feature = "defmt", derive(defmt::Format))] pub enum Either3 { /// First future finished first. First(A), /// Second future finished first. Second(B), /// Third future finished first. Third(C), } /// Same as [`select`], but with more futures. pub fn select3(a: A, b: B, c: C) -> Select3 where A: Future, B: Future, C: Future, { Select3 { a, b, c } } /// Future for the [`select3`] function. #[derive(Debug)] #[must_use = "futures do nothing unless you `.await` or poll them"] pub struct Select3 { a: A, b: B, c: C, } impl Future for Select3 where A: Future, B: Future, C: Future, { type Output = Either3; fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll { let this = unsafe { self.get_unchecked_mut() }; let a = unsafe { Pin::new_unchecked(&mut this.a) }; let b = unsafe { Pin::new_unchecked(&mut this.b) }; let c = unsafe { Pin::new_unchecked(&mut this.c) }; if let Poll::Ready(x) = a.poll(cx) { return Poll::Ready(Either3::First(x)); } if let Poll::Ready(x) = b.poll(cx) { return Poll::Ready(Either3::Second(x)); } if let Poll::Ready(x) = c.poll(cx) { return Poll::Ready(Either3::Third(x)); } Poll::Pending } } // ==================================================================== /// Result for [`select4`]. #[derive(Debug, Clone)] #[cfg_attr(feature = "defmt", derive(defmt::Format))] pub enum Either4 { /// First future finished first. First(A), /// Second future finished first. Second(B), /// Third future finished first. Third(C), /// Fourth future finished first. Fourth(D), } /// Same as [`select`], but with more futures. pub fn select4(a: A, b: B, c: C, d: D) -> Select4 where A: Future, B: Future, C: Future, D: Future, { Select4 { a, b, c, d } } /// Future for the [`select4`] function. #[derive(Debug)] #[must_use = "futures do nothing unless you `.await` or poll them"] pub struct Select4 { a: A, b: B, c: C, d: D, } impl Future for Select4 where A: Future, B: Future, C: Future, D: Future, { type Output = Either4; fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll { let this = unsafe { self.get_unchecked_mut() }; let a = unsafe { Pin::new_unchecked(&mut this.a) }; let b = unsafe { Pin::new_unchecked(&mut this.b) }; let c = unsafe { Pin::new_unchecked(&mut this.c) }; let d = unsafe { Pin::new_unchecked(&mut this.d) }; if let Poll::Ready(x) = a.poll(cx) { return Poll::Ready(Either4::First(x)); } if let Poll::Ready(x) = b.poll(cx) { return Poll::Ready(Either4::Second(x)); } if let Poll::Ready(x) = c.poll(cx) { return Poll::Ready(Either4::Third(x)); } if let Poll::Ready(x) = d.poll(cx) { return Poll::Ready(Either4::Fourth(x)); } Poll::Pending } } // ==================================================================== /// Future for the [`select_array`] function. #[derive(Debug)] #[must_use = "futures do nothing unless you `.await` or poll them"] pub struct SelectArray { inner: [Fut; N], } /// Creates a new future which will select over an array of futures. /// /// The returned future will wait for any future to be ready. Upon /// completion the item resolved will be returned, along with the index of the /// future that was ready. /// /// # Panics /// /// This function will panic if the array specified contains no items. pub fn select_array(arr: [Fut; N]) -> SelectArray { assert!(N > 0); SelectArray { inner: arr } } impl Future for SelectArray { type Output = (Fut::Output, usize); fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll { // Safety: Since `self` is pinned, `inner` cannot move. Since `inner` cannot move, // its elements also cannot move. Therefore it is safe to access `inner` and pin // references to the contained futures. let item = unsafe { self.get_unchecked_mut() .inner .iter_mut() .enumerate() .find_map(|(i, f)| match Pin::new_unchecked(f).poll(cx) { Poll::Pending => None, Poll::Ready(e) => Some((i, e)), }) }; match item { Some((idx, res)) => Poll::Ready((res, idx)), None => Poll::Pending, } } } // ==================================================================== /// Future for the [`select_slice`] function. #[derive(Debug)] #[must_use = "futures do nothing unless you `.await` or poll them"] pub struct SelectSlice<'a, Fut> { inner: &'a mut [Fut], } /// Creates a new future which will select over a slice of futures. /// /// The returned future will wait for any future to be ready. Upon /// completion the item resolved will be returned, along with the index of the /// future that was ready. /// /// # Panics /// /// This function will panic if the slice specified contains no items. pub fn select_slice<'a, Fut: Future>(slice: &'a mut [Fut]) -> SelectSlice<'a, Fut> { assert!(!slice.is_empty()); SelectSlice { inner: slice } } impl<'a, Fut: Future> Future for SelectSlice<'a, Fut> { type Output = (Fut::Output, usize); fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll { // Safety: Since `self` is pinned, `inner` cannot move. Since `inner` cannot move, // its elements also cannot move. Therefore it is safe to access `inner` and pin // references to the contained futures. let item = unsafe { self.get_unchecked_mut() .inner .iter_mut() .enumerate() .find_map(|(i, f)| match Pin::new_unchecked(f).poll(cx) { Poll::Pending => None, Poll::Ready(e) => Some((i, e)), }) }; match item { Some((idx, res)) => Poll::Ready((res, idx)), None => Poll::Pending, } } }