summaryrefslogtreecommitdiffstats
path: root/third_party/rust/tokio-stream/src/wrappers/mpsc_bounded.rs
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /third_party/rust/tokio-stream/src/wrappers/mpsc_bounded.rs
parentInitial commit. (diff)
downloadfirefox-esr-upstream.tar.xz
firefox-esr-upstream.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/tokio-stream/src/wrappers/mpsc_bounded.rs')
-rw-r--r--third_party/rust/tokio-stream/src/wrappers/mpsc_bounded.rs65
1 files changed, 65 insertions, 0 deletions
diff --git a/third_party/rust/tokio-stream/src/wrappers/mpsc_bounded.rs b/third_party/rust/tokio-stream/src/wrappers/mpsc_bounded.rs
new file mode 100644
index 0000000000..b5362680ee
--- /dev/null
+++ b/third_party/rust/tokio-stream/src/wrappers/mpsc_bounded.rs
@@ -0,0 +1,65 @@
+use crate::Stream;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+use tokio::sync::mpsc::Receiver;
+
+/// A wrapper around [`tokio::sync::mpsc::Receiver`] that implements [`Stream`].
+///
+/// [`tokio::sync::mpsc::Receiver`]: struct@tokio::sync::mpsc::Receiver
+/// [`Stream`]: trait@crate::Stream
+#[derive(Debug)]
+pub struct ReceiverStream<T> {
+ inner: Receiver<T>,
+}
+
+impl<T> ReceiverStream<T> {
+ /// Create a new `ReceiverStream`.
+ pub fn new(recv: Receiver<T>) -> Self {
+ Self { inner: recv }
+ }
+
+ /// Get back the inner `Receiver`.
+ pub fn into_inner(self) -> Receiver<T> {
+ self.inner
+ }
+
+ /// Closes the receiving half of a channel without dropping it.
+ ///
+ /// This prevents any further messages from being sent on the channel while
+ /// still enabling the receiver to drain messages that are buffered. Any
+ /// outstanding [`Permit`] values will still be able to send messages.
+ ///
+ /// To guarantee no messages are dropped, after calling `close()`, you must
+ /// receive all items from the stream until `None` is returned.
+ ///
+ /// [`Permit`]: struct@tokio::sync::mpsc::Permit
+ pub fn close(&mut self) {
+ self.inner.close()
+ }
+}
+
+impl<T> Stream for ReceiverStream<T> {
+ type Item = T;
+
+ fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ self.inner.poll_recv(cx)
+ }
+}
+
+impl<T> AsRef<Receiver<T>> for ReceiverStream<T> {
+ fn as_ref(&self) -> &Receiver<T> {
+ &self.inner
+ }
+}
+
+impl<T> AsMut<Receiver<T>> for ReceiverStream<T> {
+ fn as_mut(&mut self) -> &mut Receiver<T> {
+ &mut self.inner
+ }
+}
+
+impl<T> From<Receiver<T>> for ReceiverStream<T> {
+ fn from(recv: Receiver<T>) -> Self {
+ Self::new(recv)
+ }
+}