1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
//! An async/sync multi-producer multi-consumer channel. Multiple threads can send and receive
//! messages on the channel at the same time and each message will be received by only one thread.
//!
//! Producers can send and consumers can receive messages asynchronously or synchronously:
//! - async send -> async receive
//! - sync send -> sync receive
//! - async send -> sync receive
//! - sync send -> async receive
//!
//! There are two types of channels: bounded and unbounded.
//!
//! 1. [Bounded][`bounded()`] channel with limited capacity.
//! 2. [Unbounded][`unbounded()`] channel with unlimited capacity.
//!
//! A channel has two sides: the [`Sender`] side and the [`Receiver`] side. Both sides are cloneable, meaning
//! that they can be copied and shared among multiple threads. This allows you to have multiple
//! threads sending and receiving messages on the same channel.
//!
//! When all [`Sender`]s or all [`Receiver`]s are dropped, the channel becomes closed. This means that no
//! more messages can be sent, but remaining messages can still be received.
//!
//! The channel can also be closed manually by calling Sender::close() or Receiver::close().
//!
//! # Examples
//!
//! ```
//! let (tx, rx) = loole::unbounded();
//!
//! std::thread::spawn(move || {
//! for i in 0..10 {
//! tx.send(i).unwrap();
//! }
//! });
//!
//! let mut sum = 0;
//! while let Ok(i) = rx.recv() {
//! sum += i;
//! }
//!
//! assert_eq!(sum, (0..10).sum());
//! ```
#![forbid(unsafe_code)]
#![warn(missing_docs)]
mod mutex;
mod queue;
mod signal;
use std::future::Future;
use std::marker::PhantomData;
use std::sync::atomic::AtomicUsize;
use std::sync::atomic::Ordering;
use std::sync::Arc;
use std::task::{Context, Poll};
use std::time::{Duration, Instant};
use mutex::MutexGuard;
use queue::Queue;
use crate::mutex::Mutex;
use crate::signal::{Signal, SyncSignal};
/// An error that occurs when trying to receive a value from a channel after all senders have been
/// dropped and there are no more messages in the channel.
#[derive(PartialEq, Eq, Clone, Copy, Debug)]
pub enum RecvError {
/// No further messages can be received because all senders have been dropped and there are no messages
/// waiting in the channel.
Disconnected,
}
impl std::error::Error for RecvError {}
impl std::fmt::Display for RecvError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
RecvError::Disconnected => f.write_str("receiving on a closed channel"),
}
}
}
/// An error that occurs when trying to send a value on a channel after all receivers have been dropped.
#[derive(PartialEq, Eq, Clone, Copy)]
pub struct SendError<T>(pub T);
impl<T> std::error::Error for SendError<T> {}
impl<T> SendError<T> {
/// Consumes the error, returning the message that failed to send.
pub fn into_inner(self) -> T {
self.0
}
}
impl<T> std::fmt::Display for SendError<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str("sending on a closed channel")
}
}
impl<T> std::fmt::Debug for SendError<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str("SendError(..)")
}
}
/// An error that occurs when trying to send a value to a channel:
///
/// * When the channel is full.
/// * When all receivers have been dropped.
#[derive(PartialEq, Eq, Clone, Copy)]
pub enum TrySendError<T> {
/// The message cannot be sent because the channel is full.
Full(T),
/// All receivers have been dropped, so the message cannot be received.
Disconnected(T),
}
impl<T> TrySendError<T> {
/// Consume the error and return the message that failed to send.
pub fn into_inner(self) -> T {
match self {
Self::Full(msg) | Self::Disconnected(msg) => msg,
}
}
}
impl<T> std::fmt::Debug for TrySendError<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match *self {
TrySendError::Full(..) => f.write_str("Full(..)"),
TrySendError::Disconnected(..) => f.write_str("Disconnected(..)"),
}
}
}
impl<T> std::fmt::Display for TrySendError<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
TrySendError::Full(..) => f.write_str("sending on a full channel"),
TrySendError::Disconnected(..) => f.write_str("sending on a closed channel"),
}
}
}
impl<T> std::error::Error for TrySendError<T> {}
impl<T> From<SendError<T>> for TrySendError<T> {
fn from(err: SendError<T>) -> Self {
match err {
SendError(item) => Self::Disconnected(item),
}
}
}
/// An error that occurs when trying to receive a value from a channel when there are no messages in the channel.
/// If there are no messages in the channel and all senders are dropped, then the `Disconnected` error will be
/// returned.
#[derive(PartialEq, Eq, Clone, Copy, Debug)]
pub enum TryRecvError {
/// An error that occurs when trying to receive a value from an empty channel.
Empty,
/// The channel has been closed because all senders have been dropped and there are no more messages waiting
/// in the channel.
Disconnected,
}
impl std::fmt::Display for TryRecvError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
TryRecvError::Empty => f.write_str("receiving on an empty channel"),
TryRecvError::Disconnected => f.write_str("channel is empty and closed"),
}
}
}
impl std::error::Error for TryRecvError {}
impl From<RecvError> for TryRecvError {
fn from(err: RecvError) -> Self {
match err {
RecvError::Disconnected => Self::Disconnected,
}
}
}
/// An error that may be returned when attempting to receive a value on a channel with a timeout
/// and no value is received within the timeout period, or when all senders have been dropped and
/// there are no more values left in the channel.
#[derive(PartialEq, Eq, Clone, Copy, Debug)]
pub enum RecvTimeoutError {
/// The operation timed out while waiting for a message to be received.
Timeout,
/// The channel is empty and all senders have been dropped, so no further messages can be received.
Disconnected,
}
impl std::error::Error for RecvTimeoutError {}
impl std::fmt::Display for RecvTimeoutError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
RecvTimeoutError::Timeout => f.write_str("timed out waiting on a channel"),
RecvTimeoutError::Disconnected => f.write_str("channel is empty and closed"),
}
}
}
/// An error that may be emitted when sending a value into a channel on a sender with a timeout.
///
/// This error can occur when either:
///
/// * The send operation times out before the value is successfully sent.
/// * All receivers of the channel are dropped before the value is successfully sent.
#[derive(Copy, Clone, PartialEq, Eq)]
pub enum SendTimeoutError<T> {
/// A timeout occurred when attempting to send the message.
Timeout(T),
/// The message cannot be sent because all channel receivers were dropped.
Disconnected(T),
}
impl<T> std::error::Error for SendTimeoutError<T> {}
impl<T> SendTimeoutError<T> {
/// Consumes the error, returning the message that failed to send.
pub fn into_inner(self) -> T {
match self {
Self::Timeout(msg) | Self::Disconnected(msg) => msg,
}
}
}
impl<T> std::fmt::Debug for SendTimeoutError<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str("SendTimeoutError(..)")
}
}
impl<T> std::fmt::Display for SendTimeoutError<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
SendTimeoutError::Timeout(..) => f.write_str("timed out sending on a full channel"),
SendTimeoutError::Disconnected(..) => f.write_str("sending on a closed channel"),
}
}
}
impl<T> From<SendError<T>> for SendTimeoutError<T> {
fn from(value: SendError<T>) -> Self {
SendTimeoutError::Disconnected(value.0)
}
}
/// An iterator over the msgs received synchronously from a channel.
pub struct Iter<'a, T> {
receiver: &'a Receiver<T>,
}
/// An non-blocking iterator over the msgs received synchronously from a channel.
pub struct TryIter<'a, T> {
receiver: &'a Receiver<T>,
}
/// An owned iterator over the msgs received synchronously from a channel.
pub struct IntoIter<T> {
receiver: Receiver<T>,
}
impl<T> Iterator for IntoIter<T> {
type Item = T;
fn next(&mut self) -> Option<Self::Item> {
self.receiver.recv().ok()
}
}
#[derive(Debug)]
struct SharedState<T> {
pending_recvs: Queue<Signal>,
pending_sends: Queue<(T, Option<Signal>)>,
queue: Queue<T>,
closed: bool,
cap: Option<usize>,
next_id: usize,
}
impl<T> SharedState<T> {
fn new(cap: Option<usize>) -> Self {
let pending_sends = cap.map_or_else(Queue::new, Queue::with_capacity);
Self {
pending_recvs: Queue::new(),
pending_sends,
queue: Queue::new(),
closed: false,
cap,
next_id: 1,
}
}
fn len(&self) -> usize {
self.queue.len()
}
fn is_full(&self) -> bool {
Some(self.len()) == self.cap
}
fn is_empty(&self) -> bool {
self.len() == 0
}
fn get_next_id(&mut self) -> usize {
let id = self.next_id;
self.next_id = self.next_id.wrapping_add(1);
id
}
fn close(&mut self) -> bool {
let was_closed = self.closed;
self.closed = true;
for (_, s) in self.pending_recvs.iter() {
s.wake_by_ref();
}
for (_, (_, s)) in self.pending_sends.iter() {
if let Some(s) = s {
s.wake_by_ref();
}
}
!was_closed
}
fn is_closed(&self) -> bool {
self.closed
}
}
enum TrySendResult<'a, T> {
Ok,
Disconnected(T),
Full(T, MutexGuard<'a, SharedState<T>>),
}
#[inline(always)]
fn try_send<T>(m: T, id: usize, mut guard: MutexGuard<'_, SharedState<T>>) -> TrySendResult<T> {
if guard.closed {
return TrySendResult::Disconnected(m);
}
if !guard.is_full() {
guard.queue.enqueue(id, m);
if let Some((_, s)) = guard.pending_recvs.dequeue() {
drop(guard);
s.wake();
}
return TrySendResult::Ok;
} else if guard.cap == Some(0) {
if let Some((_, s)) = guard.pending_recvs.dequeue() {
guard.pending_sends.enqueue(id, (m, None));
drop(guard);
s.wake();
return TrySendResult::Ok;
}
}
TrySendResult::Full(m, guard)
}
enum TryRecvResult<'a, T> {
Ok(T),
Disconnected,
Empty(MutexGuard<'a, SharedState<T>>),
}
#[inline(always)]
fn try_recv<T>(mut guard: MutexGuard<'_, SharedState<T>>) -> TryRecvResult<T> {
if let Some((_, m)) = guard.queue.dequeue() {
if let Some((id, (m, s))) = guard.pending_sends.dequeue() {
guard.queue.enqueue(id, m);
if let Some(s) = s {
drop(guard);
s.wake();
}
}
return TryRecvResult::Ok(m);
} else if guard.cap == Some(0) {
if let Some((_, (m, s))) = guard.pending_sends.dequeue() {
if let Some(s) = s {
drop(guard);
s.wake();
}
return TryRecvResult::Ok(m);
}
}
if guard.closed {
return TryRecvResult::Disconnected;
}
TryRecvResult::Empty(guard)
}
/// A future that sends a value into a channel.
#[must_use = "futures do nothing unless you `.await` or poll them"]
#[derive(Debug)]
pub struct SendFuture<T> {
shared_state: Arc<Mutex<SharedState<T>>>,
msg: Option<T>,
}
impl<T> std::marker::Unpin for SendFuture<T> {}
impl<T> Future for SendFuture<T> {
type Output = Result<(), SendError<T>>;
fn poll(mut self: std::pin::Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let m = match self.msg.take() {
Some(m) => m,
None => {
let mut guard = self.shared_state.lock();
if guard.closed {
if let Some((_, (m, Some(_)))) = guard.pending_sends.dequeue() {
return Poll::Ready(Err(SendError(m)));
}
}
return Poll::Ready(Ok(()));
}
};
let mut guard = self.shared_state.lock();
let id = guard.get_next_id();
let (m, mut guard) = match try_send(m, id, guard) {
TrySendResult::Ok => return Poll::Ready(Ok(())),
TrySendResult::Disconnected(m) => return Poll::Ready(Err(SendError(m))),
TrySendResult::Full(m, guard) => (m, guard),
};
guard
.pending_sends
.enqueue(id, (m, Some(cx.waker().clone().into())));
if let Some((_, s)) = guard.pending_recvs.dequeue() {
drop(guard);
s.wake();
}
Poll::Pending
}
}
/// A future that allows asynchronously receiving a message.
/// This future will resolve to a message when a message is available on the channel,
/// or to an error if the channel is closed.
#[must_use = "futures do nothing unless you `.await` or poll them"]
#[derive(Debug)]
pub struct RecvFuture<T> {
id: usize,
shared_state: Arc<Mutex<SharedState<T>>>,
}
impl<T> Future for RecvFuture<T> {
type Output = Result<T, RecvError>;
fn poll(self: std::pin::Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let mut guard = match try_recv(self.shared_state.lock()) {
TryRecvResult::Ok(r) => return Poll::Ready(Ok(r)),
TryRecvResult::Disconnected => return Poll::Ready(Err(RecvError::Disconnected)),
TryRecvResult::Empty(guard) => guard,
};
if guard.closed {
return Poll::Ready(Err(RecvError::Disconnected));
}
if !guard.pending_recvs.contains(self.id) {
guard
.pending_recvs
.enqueue(self.id, cx.waker().clone().into());
}
Poll::Pending
}
}
impl<T> Drop for RecvFuture<T> {
fn drop(&mut self) {
let mut guard = self.shared_state.lock();
guard.pending_recvs.remove(self.id);
}
}
/// The sending half of a channel.
pub struct Sender<T> {
shared_state: Arc<Mutex<SharedState<T>>>,
send_count: Arc<AtomicUsize>,
next_id: Arc<AtomicUsize>,
}
impl<T> std::fmt::Debug for Sender<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("Sender").finish()
}
}
impl<T> Clone for Sender<T> {
/// Clones this sender. A [`Sender`] acts as a handle to the sending end of a channel. The remaining
/// contents of the channel will only be cleaned up when all senders and the receiver have been dropped.
fn clone(&self) -> Self {
self.send_count.fetch_add(1, Ordering::Relaxed);
Self {
shared_state: Arc::clone(&self.shared_state),
send_count: Arc::clone(&self.send_count),
next_id: Arc::clone(&self.next_id),
}
}
}
impl<T> Sender<T> {
fn new(shared_state: Arc<Mutex<SharedState<T>>>) -> Self {
Self {
shared_state,
send_count: Arc::new(AtomicUsize::new(1)),
next_id: Arc::new(AtomicUsize::new(1)),
}
}
fn get_next_id(&self) -> usize {
self.next_id.fetch_add(1, Ordering::Relaxed)
}
/// It returns an error if the channel is bounded and full, or if all receivers have been dropped.
/// If the channel is unbounded, the method behaves the same as the [`Sender::send`] method.
///
/// This method is useful for avoiding deadlocks. If you are sending a value into a channel and
/// you are not sure if the channel is full or if all receivers have been dropped, you can use
/// this method instead of the [`Sender::send`] method. If this method returns an error, you can
/// take appropriate action, such as retrying the send operation later or buffering the value
/// until you can send it successfully.
pub fn try_send(&self, m: T) -> Result<(), TrySendError<T>> {
match try_send(m, self.get_next_id(), self.shared_state.lock()) {
TrySendResult::Ok => Ok(()),
TrySendResult::Disconnected(m) => Err(TrySendError::Disconnected(m)),
TrySendResult::Full(m, _) => Err(TrySendError::Full(m)),
}
}
/// Asynchronously send a value into the channel, it will return a future that completes when the
/// value has been successfully sent, or when an error has occurred.
///
/// The method returns an error if all receivers on the channel have been dropped.
/// If the channel is bounded and is full, the returned future will yield to the async runtime.
pub fn send_async(&self, m: T) -> SendFuture<T> {
SendFuture {
shared_state: Arc::clone(&self.shared_state),
msg: Some(m),
}
}
/// Sends a value into the channel. Returns an error if all receivers have been dropped, or if
/// the channel is bounded and is full and no receivers are available.
pub fn send(&self, m: T) -> Result<(), SendError<T>> {
let id = self.get_next_id();
let (m, mut guard) = match try_send(m, id, self.shared_state.lock()) {
TrySendResult::Ok => return Ok(()),
TrySendResult::Disconnected(m) => return Err(SendError(m)),
TrySendResult::Full(m, guard) => (m, guard),
};
let sync_signal = SyncSignal::new();
guard
.pending_sends
.enqueue(id, (m, Some(sync_signal.clone().into())));
drop(guard);
sync_signal.wait();
let mut guard = self.shared_state.lock();
if guard.closed {
if let Some((_, (m, Some(_)))) = guard.pending_sends.remove(id) {
return Err(SendError(m));
}
}
Ok(())
}
/// Attempts to send a value into the channel.
///
/// If all receivers have been dropped or the timeout has expired, this method will return
/// an error. If the channel is bounded and is full, this method will block until space is
/// available, the timeout has expired, or all receivers have been dropped.
pub fn send_timeout(&self, m: T, timeout: Duration) -> Result<(), SendTimeoutError<T>> {
let id = self.get_next_id();
let (m, mut guard) = match try_send(m, id, self.shared_state.lock()) {
TrySendResult::Ok => return Ok(()),
TrySendResult::Disconnected(m) => return Err(SendTimeoutError::Disconnected(m)),
TrySendResult::Full(m, guard) => (m, guard),
};
let sync_signal = SyncSignal::new();
guard.pending_sends.enqueue(id, (m, None));
drop(guard);
let _ = sync_signal.wait_timeout(timeout);
let mut guard = self.shared_state.lock();
if let Some((_, (m, _))) = guard.pending_sends.remove(id) {
if guard.closed {
return Err(SendTimeoutError::Disconnected(m));
}
return Err(SendTimeoutError::Timeout(m));
}
Ok(())
}
/// Sends a value into the channel, returning an error if the channel is full and the
/// deadline has passed, or if all receivers have been dropped.
pub fn send_deadline(&self, m: T, deadline: Instant) -> Result<(), SendTimeoutError<T>> {
self.send_timeout(m, deadline.checked_duration_since(Instant::now()).unwrap())
}
/// Returns `true` if the two senders belong to the same channel, and `false` otherwise.
pub fn same_channel(&self, other: &Sender<T>) -> bool {
Arc::ptr_eq(&self.shared_state, &other.shared_state)
}
/// Returns the number of messages currently in the channel.
///
/// This function is useful for determining how many messages are waiting to be processed
/// by consumers, or for implementing backpressure mechanisms.
pub fn len(&self) -> usize {
self.shared_state.lock().len()
}
/// Returns the capacity of the channel, if it is bounded. Otherwise, returns `None`.
pub fn capacity(&self) -> Option<usize> {
self.shared_state.lock().cap
}
/// Returns true if the channel is empty.
///
/// Note: Zero-capacity channels are always empty.
pub fn is_empty(&self) -> bool {
self.shared_state.lock().is_empty()
}
/// Returns true if the channel is full.
///
/// Note: Zero-capacity channels are always full.
pub fn is_full(&self) -> bool {
self.shared_state.lock().is_full()
}
/// Closes the channel.
///
/// Returns true only if this call actively closed the channel, which was previously open.
///
/// The remaining messages can still be received.
pub fn close(&self) -> bool {
self.shared_state.lock().close()
}
/// Returns true if the channel is closed.
pub fn is_closed(&self) -> bool {
self.shared_state.lock().is_closed()
}
}
impl<T> Drop for Sender<T> {
fn drop(&mut self) {
let _ = self
.send_count
.fetch_update(Ordering::Relaxed, Ordering::Relaxed, |c| {
let mut count = c;
if count > 0 {
count -= 1;
if count == 0 {
self.shared_state.lock().close();
}
}
Some(count)
});
}
}
/// The receiving end of a channel.
///
/// Note: Cloning the receiver *does not* turn this channel into a broadcast channel.
/// Each message will only be received by a single receiver. This is useful for
/// implementing work stealing for concurrent programs.
pub struct Receiver<T> {
shared_state: Arc<Mutex<SharedState<T>>>,
recv_count: Arc<AtomicUsize>,
next_id: Arc<AtomicUsize>,
}
impl<T> std::fmt::Debug for Receiver<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("Receiver").finish()
}
}
impl<T> Clone for Receiver<T> {
/// Clone this receiver. [`Receiver`] acts as a handle to the ending a channel. Remaining
/// channel contents will only be cleaned up when all senders and the receiver have been
/// dropped.
///
/// Note: Cloning the receiver *does not* turn this channel into a broadcast channel.
/// Each message will only be received by a single receiver. This is useful for
/// implementing work stealing for concurrent programs.
fn clone(&self) -> Self {
self.recv_count.fetch_add(1, Ordering::Relaxed);
Self {
shared_state: Arc::clone(&self.shared_state),
recv_count: Arc::clone(&self.recv_count),
next_id: Arc::clone(&self.next_id),
}
}
}
impl<T> Receiver<T> {
fn new(shared_state: Arc<Mutex<SharedState<T>>>) -> Self {
Self {
shared_state,
recv_count: Arc::new(AtomicUsize::new(1)),
next_id: Arc::new(AtomicUsize::new(1)),
}
}
fn get_next_id(&self) -> usize {
self.next_id.fetch_add(1, Ordering::Relaxed)
}
/// Attempts to receive a value from the channel associated with this receiver, returning an error if
/// the channel is empty or if all senders have been dropped.
///
/// This method will block until a value is available on the channel, or until the channel is empty
/// or all senders have been dropped.
pub fn try_recv(&self) -> Result<T, TryRecvError> {
match try_recv(self.shared_state.lock()) {
TryRecvResult::Ok(m) => Ok(m),
TryRecvResult::Disconnected => Err(TryRecvError::Disconnected),
TryRecvResult::Empty(_) => Err(TryRecvError::Empty),
}
}
/// Asynchronously receive a value from the channel, returning an error if all senders have been dropped.
/// If the channel is empty, the returned future will yield to the async runtime.
///
/// This method returns a future that will be resolved with the value received from the channel,
/// or with an error if the channel is closed.
pub fn recv_async(&self) -> RecvFuture<T> {
RecvFuture {
id: self.get_next_id(),
shared_state: Arc::clone(&self.shared_state),
}
}
/// Wait for an incoming value from the channel associated with this receiver. If all senders have been
/// dropped and there are no more messages in the channel, this method will return an error.
pub fn recv(&self) -> Result<T, RecvError> {
loop {
let mut guard = match try_recv(self.shared_state.lock()) {
TryRecvResult::Ok(r) => return Ok(r),
TryRecvResult::Disconnected => return Err(RecvError::Disconnected),
TryRecvResult::Empty(guard) => guard,
};
let id = self.get_next_id();
let sync_signal = SyncSignal::new();
guard.pending_recvs.enqueue(id, sync_signal.clone().into());
drop(guard);
sync_signal.wait();
}
}
/// Receives a value from the channel associated with this receiver, blocking the current thread
/// until a value is available or the timeout expires.
pub fn recv_timeout(&self, timeout: Duration) -> Result<T, RecvTimeoutError> {
let start_time = Instant::now();
let mut timeout_remaining = timeout;
loop {
let mut guard = match try_recv(self.shared_state.lock()) {
TryRecvResult::Ok(r) => return Ok(r),
TryRecvResult::Disconnected => return Err(RecvTimeoutError::Disconnected),
TryRecvResult::Empty(guard) => guard,
};
if guard.closed {
return Err(RecvTimeoutError::Disconnected);
}
let id = self.get_next_id();
let sync_signal = SyncSignal::new();
guard.pending_recvs.enqueue(id, sync_signal.clone().into());
drop(guard);
let _ = sync_signal.wait_timeout(timeout_remaining);
let elapsed = start_time.elapsed();
if elapsed >= timeout {
return Err(RecvTimeoutError::Timeout);
}
timeout_remaining = timeout - elapsed;
}
}
/// Receives a value from the channel associated with this receiver, blocking the current thread
/// until a value is available or the deadline has passed.
pub fn recv_deadline(&self, deadline: Instant) -> Result<T, RecvTimeoutError> {
self.recv_timeout(deadline.checked_duration_since(Instant::now()).unwrap())
}
/// Take all msgs currently sitting in the channel and produce an iterator over them. Unlike
/// `try_iter`, the iterator will not attempt to fetch any more values from the channel once
/// the function has been called.
pub fn drain(&self) -> Drain<T> {
let mut guard = self.shared_state.lock();
let queue = std::mem::take(&mut guard.queue);
let n = guard
.cap
.map_or(0, |cap| cap.min(guard.pending_sends.len()));
for _ in 0..n {
if let Some((id, (m, mut s))) = guard.pending_sends.dequeue() {
guard.queue.enqueue(id, m);
if let Some(s) = s.take() {
s.wake();
}
}
}
Drain {
queue,
_phantom: PhantomData,
}
}
/// Returns a blocking iterator over the values received on the channel. The iterator will finish
/// iteration when all senders have been dropped.
pub fn iter(&self) -> Iter<T> {
Iter { receiver: self }
}
/// An iterator over the values received on the channel that finishes iteration when all senders
/// have been dropped or the channel is empty.
///
/// This iterator is non-blocking, meaning that it will not wait for the next value to be available
/// if there is not one already. If there is no value available, the iterator will return `None`.
pub fn try_iter(&self) -> TryIter<T> {
TryIter { receiver: self }
}
/// Returns `true` if the two receivers belong to the same channel, and `false` otherwise.
pub fn same_channel(&self, other: &Receiver<T>) -> bool {
Arc::ptr_eq(&self.shared_state, &other.shared_state)
}
/// Returns the number of messages currently in the channel.
///
/// This function is useful for determining how many messages are waiting to be processed
/// by consumers, or for implementing backpressure mechanisms.
pub fn len(&self) -> usize {
self.shared_state.lock().len()
}
/// Returns the capacity of the channel, if it is bounded. Otherwise, returns `None`.
pub fn capacity(&self) -> Option<usize> {
self.shared_state.lock().cap
}
/// Returns true if the channel is empty.
///
/// Note: Zero-capacity channels are always empty.
pub fn is_empty(&self) -> bool {
self.shared_state.lock().is_empty()
}
/// Returns true if the channel is full.
///
/// Note: Zero-capacity channels are always full.
pub fn is_full(&self) -> bool {
self.shared_state.lock().is_full()
}
/// Closes the channel.
///
/// Returns true only if this call actively closed the channel, which was previously open.
///
/// The remaining messages can still be received.
pub fn close(&self) -> bool {
self.shared_state.lock().close()
}
/// Returns true if the channel is closed.
pub fn is_closed(&self) -> bool {
self.shared_state.lock().is_closed()
}
}
impl<T> Drop for Receiver<T> {
fn drop(&mut self) {
let _ = self
.recv_count
.fetch_update(Ordering::Relaxed, Ordering::Relaxed, |c| {
let mut count = c;
if count > 0 {
count -= 1;
if count == 0 {
self.shared_state.lock().close();
}
}
Some(count)
});
}
}
/// An fixed-sized iterator over the msgs drained from a channel.
#[derive(Debug)]
pub struct Drain<'a, T> {
queue: Queue<T>,
/// A phantom field used to constrain the lifetime of this iterator. We do this because the
/// implementation may change and we don't want to unintentionally constrain it. Removing this
/// lifetime later is a possibility.
_phantom: PhantomData<&'a ()>,
}
impl<'a, T> Iterator for Drain<'a, T> {
type Item = T;
fn next(&mut self) -> Option<Self::Item> {
self.queue.dequeue().map(|(_, x)| x)
}
}
impl<'a, T> ExactSizeIterator for Drain<'a, T> {
fn len(&self) -> usize {
self.queue.len()
}
}
impl<'a, T> Iterator for Iter<'a, T> {
type Item = T;
fn next(&mut self) -> Option<Self::Item> {
self.receiver.recv().ok()
}
}
impl<'a, T> Iterator for TryIter<'a, T> {
type Item = T;
fn next(&mut self) -> Option<Self::Item> {
self.receiver.try_recv().ok()
}
}
impl<'a, T> IntoIterator for &'a Receiver<T> {
type Item = T;
type IntoIter = Iter<'a, T>;
fn into_iter(self) -> Self::IntoIter {
Iter { receiver: self }
}
}
impl<T> IntoIterator for Receiver<T> {
type Item = T;
type IntoIter = IntoIter<T>;
fn into_iter(self) -> Self::IntoIter {
IntoIter { receiver: self }
}
}
fn channel<T>(cap: Option<usize>) -> (Sender<T>, Receiver<T>) {
let shared_state = Arc::new(Mutex::new(SharedState::new(cap)));
let sender = Sender::new(Arc::clone(&shared_state));
let receiver = Receiver::new(shared_state);
(sender, receiver)
}
/// Create a bounded channel with a limited maximum capacity.
///
/// Returns a tuple of a [`Sender`] and a [`Receiver`], which can be used to send and receive messages, respectively.
/// The channel has a limited capacity, which means that it can only hold a certain number of messages at a time.
/// If the channel is full, calls to [`Sender::send`] will block until there is space available.
///
/// Bounded channels are useful for controlling the flow of data between threads. For example, you can use a bounded
/// channel to prevent a producer thread from overwhelming a consumer thread.
///
/// Unlike an [`unbounded`] channel, if there is no space left for new messages, calls to
/// [`Sender::send`] will block (unblocking once a receiver has made space). If blocking behaviour
/// is not desired, [`Sender::try_send`] may be used.
///
/// Also 'rendezvous' channels are supported by loole. A bounded queue with a limited maximum capacity of zero will
/// block senders until a receiver is available to take the value.
///
/// Producers can send and consumers can receive messages asynchronously or synchronously.
///
/// # Examples
/// ```
/// let (tx, rx) = loole::bounded(3);
///
/// tx.send(1).unwrap();
/// tx.send(2).unwrap();
/// tx.send(3).unwrap();
///
/// assert!(tx.try_send(4).is_err());
///
/// let mut sum = 0;
/// sum += rx.recv().unwrap();
/// sum += rx.recv().unwrap();
/// sum += rx.recv().unwrap();
///
/// assert!(rx.try_recv().is_err());
///
/// assert_eq!(sum, 1 + 2 + 3);
/// ```
pub fn bounded<T>(cap: usize) -> (Sender<T>, Receiver<T>) {
channel(Some(cap))
}
/// Creates an unbounded channel, which has unlimited capacity.
///
/// This function creates a pair of sender and receiver halves of a channel. Values sent on the sender half will be
/// received on the receiver half, in the same order in which they were sent. The channel is thread-safe, and both
/// sender and receiver halves can be sent to or shared between threads as needed. Additionally, both sender and
/// receiver halves can be cloned.
///
/// Producers can send and consumers can receive messages asynchronously or synchronously.
///
/// # Examples
/// ```
/// let (tx, rx) = loole::unbounded();
///
/// tx.send(10).unwrap();
/// assert_eq!(rx.recv().unwrap(), 10);
/// ```
pub fn unbounded<T>() -> (Sender<T>, Receiver<T>) {
channel(None)
}