From 30dcc880933a6e37f4b4e3e297d0a4fab586befb Mon Sep 17 00:00:00 2001
From: nerwalt <tlawren@gmail.com>
Date: Fri, 19 Apr 2024 12:16:12 -0600
Subject: [PATCH] Adding ready_to_receive to Channel and Receiver Adding
ReceiveReadyFuture
---
embassy-sync/src/channel.rs | 35 +++++++++++++++++++++++++++++++++++
1 file changed, 35 insertions(+)
diff --git a/embassy-sync/src/channel.rs b/embassy-sync/src/channel.rs
index 18be462cb..c4267064c 100644
--- a/embassy-sync/src/channel.rs
+++ b/embassy-sync/src/channel.rs
@@ -152,6 +152,13 @@ where
self.channel.receive()
}
+ /// Is a value ready to be received in the channel
+ ///
+ /// See [`Channel::ready_to_receive()`].
+ pub fn ready_to_receive(&self) -> ReceiveReadyFuture<'_, M, T, N> {
+ self.channel.ready_to_receive()
+ }
+
/// Attempt to immediately receive the next value.
///
/// See [`Channel::try_receive()`]
@@ -246,6 +253,26 @@ where
}
}
+/// Future returned by [`Channel::ready_to_receive`] and [`Receiver::ready_to_receive`].
+#[must_use = "futures do nothing unless you `.await` or poll them"]
+pub struct ReceiveReadyFuture<'ch, M, T, const N: usize>
+where
+ M: RawMutex,
+{
+ channel: &'ch Channel<M, T, N>,
+}
+
+impl<'ch, M, T, const N: usize> Future for ReceiveReadyFuture<'ch, M, T, N>
+where
+ M: RawMutex,
+{
+ type Output = ();
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()> {
+ self.channel.poll_ready_to_receive(cx)
+ }
+}
+
/// Future returned by [`DynamicReceiver::receive`].
#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct DynamicReceiveFuture<'ch, T> {
@@ -577,6 +604,14 @@ where
ReceiveFuture { channel: self }
}
+ /// Is a value ready to be received in the channel
+ ///
+ /// If there are no messages in the channel's buffer, this method will
+ /// wait until there is at least one
+ pub fn ready_to_receive(&self) -> ReceiveReadyFuture<'_, M, T, N> {
+ ReceiveReadyFuture { channel: self }
+ }
+
/// Attempt to immediately receive a message.
///
/// This method will either receive a message from the channel immediately or return an error