Initial commit
This commit is contained in:
commit
e90d25927d
|
@ -0,0 +1 @@
|
|||
github: stjepang
|
|
@ -0,0 +1,51 @@
|
|||
name: Build and test
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
build_and_test:
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [ubuntu-latest]
|
||||
rust: [nightly, beta, stable]
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Set current week of the year in environnement
|
||||
if: startsWith(matrix.os, 'ubuntu') || startsWith(matrix.os, 'macOS')
|
||||
run: echo "::set-env name=CURRENT_WEEK::$(date +%V)"
|
||||
|
||||
- name: Set current week of the year in environnement
|
||||
if: startsWith(matrix.os, 'windows')
|
||||
run: echo "::set-env name=CURRENT_WEEK::$(Get-Date -UFormat %V)"
|
||||
|
||||
- name: Install latest ${{ matrix.rust }}
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: ${{ matrix.rust }}
|
||||
profile: minimal
|
||||
override: true
|
||||
|
||||
- name: Run cargo check
|
||||
uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: check
|
||||
args: --all --bins --examples --tests --all-features
|
||||
|
||||
- name: Run cargo check (without dev-dependencies to catch missing feature flags)
|
||||
if: startsWith(matrix.rust, 'nightly')
|
||||
uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: check
|
||||
args: -Z features=dev_dep
|
||||
|
||||
- name: Run cargo test
|
||||
uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: test
|
|
@ -0,0 +1,26 @@
|
|||
name: Lint
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
clippy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Set current week of the year in environnement
|
||||
run: echo "::set-env name=CURRENT_WEEK::$(date +%V)"
|
||||
|
||||
- uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: stable
|
||||
profile: minimal
|
||||
components: clippy
|
||||
- uses: actions-rs/clippy-check@v1
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
args: --all-features -- -W clippy::all
|
|
@ -0,0 +1,20 @@
|
|||
name: Security audit
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
security_audit:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Set current week of the year in environnement
|
||||
run: echo "::set-env name=CURRENT_WEEK::$(date +%V)"
|
||||
|
||||
- uses: actions-rs/audit-check@v1
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
|
@ -0,0 +1,3 @@
|
|||
/target
|
||||
**/*.rs.bk
|
||||
Cargo.lock
|
|
@ -0,0 +1,3 @@
|
|||
# Version 1.0.0
|
||||
|
||||
- Initial version
|
|
@ -0,0 +1,23 @@
|
|||
[package]
|
||||
name = "async-channel"
|
||||
version = "1.0.0"
|
||||
authors = ["Stjepan Glavina <stjepang@gmail.com>"]
|
||||
edition = "2018"
|
||||
description = "Async multi-producer multi-consumer channel"
|
||||
license = "Apache-2.0 OR MIT"
|
||||
repository = "https://github.com/stjepang/async-channel"
|
||||
homepage = "https://github.com/stjepang/async-channel"
|
||||
documentation = "https://docs.rs/async-channel"
|
||||
keywords = ["mpmc", "mpsc", "spmc", "chan", "futures"]
|
||||
categories = ["asynchronous", "concurrency"]
|
||||
readme = "README.md"
|
||||
|
||||
[dependencies]
|
||||
concurrent-queue = "1.0.0"
|
||||
event-listener = "2.0.0"
|
||||
futures-core = "0.3.5"
|
||||
|
||||
[dev-dependencies]
|
||||
blocking = "0.4.4"
|
||||
easy-parallel = "3.0.0"
|
||||
futures-util = { version = "0.3.5", default-features = false }
|
|
@ -0,0 +1,201 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
|
@ -0,0 +1,23 @@
|
|||
Permission is hereby granted, free of charge, to any
|
||||
person obtaining a copy of this software and associated
|
||||
documentation files (the "Software"), to deal in the
|
||||
Software without restriction, including without
|
||||
limitation the rights to use, copy, modify, merge,
|
||||
publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software
|
||||
is furnished to do so, subject to the following
|
||||
conditions:
|
||||
|
||||
The above copyright notice and this permission notice
|
||||
shall be included in all copies or substantial portions
|
||||
of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
|
||||
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
|
||||
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
|
||||
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
|
||||
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
|
||||
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
DEALINGS IN THE SOFTWARE.
|
|
@ -0,0 +1,47 @@
|
|||
# async-channel
|
||||
|
||||
[![Build](https://github.com/stjepang/async-channel/workflows/Build%20and%20test/badge.svg)](
|
||||
https://github.com/stjepang/async-channel/actions)
|
||||
[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](
|
||||
https://github.com/stjepang/async-channel)
|
||||
[![Cargo](https://img.shields.io/crates/v/async-channel.svg)](
|
||||
https://crates.io/crates/async-channel)
|
||||
[![Documentation](https://docs.rs/async-channel/badge.svg)](
|
||||
https://docs.rs/async-channel)
|
||||
|
||||
An async multi-producer multi-consumer channel.
|
||||
|
||||
There are two kinds of channels:
|
||||
|
||||
1. Bounded channel with limited capacity.
|
||||
2. Unbounded channel with unlimited capacity.
|
||||
|
||||
A channel has the `Sender` and `Receiver` side. Both sides are cloneable and can be shared
|
||||
among multiple threads.
|
||||
|
||||
When all `Sender`s or all `Receiver`s are dropped, the channel becomes closed. When a
|
||||
channel is closed, no more messages can be sent, but remaining messages can still be received.
|
||||
|
||||
## Examples
|
||||
|
||||
```rust
|
||||
let (s, r) = async_channel::unbounded();
|
||||
|
||||
assert_eq!(s.send("Hello").await, Ok(()));
|
||||
assert_eq!(r.recv().await, Ok("Hello"));
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Licensed under either of
|
||||
|
||||
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
|
||||
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
||||
|
||||
at your option.
|
||||
|
||||
#### Contribution
|
||||
|
||||
Unless you explicitly state otherwise, any contribution intentionally submitted
|
||||
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
|
||||
dual licensed as above, without any additional terms or conditions.
|
|
@ -0,0 +1,700 @@
|
|||
//! An async multi-producer multi-consumer channel.
|
||||
//!
|
||||
//! There are two kinds of channels:
|
||||
//!
|
||||
//! 1. [Bounded][`bounded()`] channel with limited capacity.
|
||||
//! 2. [Unbounded][`unbounded()`] channel with unlimited capacity.
|
||||
//!
|
||||
//! A channel has the [`Sender`] and [`Receiver`] side. Both sides are cloneable and can be shared
|
||||
//! among multiple threads.
|
||||
//!
|
||||
//! When all [`Sender`]s or all [`Receiver`]s are dropped, the channel becomes closed. When a
|
||||
//! channel is closed, no more messages can be sent, but remaining messages can still be received.
|
||||
//!
|
||||
//! # Examples
|
||||
//!
|
||||
//! ```
|
||||
//! # blocking::block_on! {
|
||||
//! let (s, r) = async_channel::unbounded();
|
||||
//!
|
||||
//! assert_eq!(s.send("Hello").await, Ok(()));
|
||||
//! assert_eq!(r.recv().await, Ok("Hello"));
|
||||
//! # }
|
||||
//! ```
|
||||
|
||||
#![warn(missing_docs, missing_debug_implementations, rust_2018_idioms)]
|
||||
|
||||
use std::error;
|
||||
use std::fmt;
|
||||
use std::future::Future;
|
||||
use std::pin::Pin;
|
||||
use std::process;
|
||||
use std::sync::atomic::{AtomicUsize, Ordering};
|
||||
use std::sync::Arc;
|
||||
use std::task::{Context, Poll};
|
||||
|
||||
use concurrent_queue::{ConcurrentQueue, PopError, PushError};
|
||||
use event_listener::{Event, EventListener};
|
||||
use futures_core::stream::Stream;
|
||||
|
||||
struct Channel<T> {
|
||||
/// Inner message queue.
|
||||
queue: ConcurrentQueue<T>,
|
||||
|
||||
/// Send operations waiting while the channel is full.
|
||||
send_ops: Event,
|
||||
|
||||
/// Receive operations waiting while the channel is empty and not closed.
|
||||
recv_ops: Event,
|
||||
|
||||
/// Stream operations while the channel is empty and not closed.
|
||||
stream_ops: Event,
|
||||
|
||||
/// The number of currently active `Sender`s.
|
||||
sender_count: AtomicUsize,
|
||||
|
||||
/// The number of currently active `Receivers`s.
|
||||
receiver_count: AtomicUsize,
|
||||
}
|
||||
|
||||
impl<T> Channel<T> {
|
||||
/// Closes the channel and notifies all blocked operations.
|
||||
fn close(&self) {
|
||||
if self.queue.close() {
|
||||
// Notify all send operations.
|
||||
self.send_ops.notify(usize::MAX);
|
||||
|
||||
// Notify all receive and stream operations.
|
||||
self.recv_ops.notify(usize::MAX);
|
||||
self.stream_ops.notify(usize::MAX);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates a bounded channel.
|
||||
///
|
||||
/// The created channel has space to hold at most `cap` messages at a time.
|
||||
///
|
||||
/// # Panics
|
||||
///
|
||||
/// Capacity must be a positive number. If `cap` is zero, this function will panic.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// # blocking::block_on! {
|
||||
/// use async_channel::{bounded, TryRecvError, TrySendError};
|
||||
///
|
||||
/// let (s, r) = bounded(1);
|
||||
///
|
||||
/// assert_eq!(s.send(10).await, Ok(()));
|
||||
/// assert_eq!(s.try_send(20), Err(TrySendError::Full(20)));
|
||||
///
|
||||
/// assert_eq!(r.recv().await, Ok(10));
|
||||
/// assert_eq!(r.try_recv(), Err(TryRecvError::Empty));
|
||||
/// # }
|
||||
pub fn bounded<T>(cap: usize) -> (Sender<T>, Receiver<T>) {
|
||||
assert!(cap > 0, "capacity cannot be zero");
|
||||
|
||||
let channel = Arc::new(Channel {
|
||||
queue: ConcurrentQueue::bounded(cap),
|
||||
send_ops: Event::new(),
|
||||
recv_ops: Event::new(),
|
||||
stream_ops: Event::new(),
|
||||
sender_count: AtomicUsize::new(1),
|
||||
receiver_count: AtomicUsize::new(1),
|
||||
});
|
||||
|
||||
let s = Sender {
|
||||
channel: channel.clone(),
|
||||
};
|
||||
let r = Receiver {
|
||||
channel,
|
||||
listener: None,
|
||||
};
|
||||
(s, r)
|
||||
}
|
||||
|
||||
/// Creates an unbounded channel.
|
||||
///
|
||||
/// The created channel can hold an unlimited number of messages.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// # blocking::block_on! {
|
||||
/// use async_channel::{unbounded, TryRecvError};
|
||||
///
|
||||
/// let (s, r) = unbounded();
|
||||
///
|
||||
/// assert_eq!(s.send(10).await, Ok(()));
|
||||
/// assert_eq!(s.send(20).await, Ok(()));
|
||||
///
|
||||
/// assert_eq!(r.recv().await, Ok(10));
|
||||
/// assert_eq!(r.recv().await, Ok(20));
|
||||
/// assert_eq!(r.try_recv(), Err(TryRecvError::Empty));
|
||||
/// # }
|
||||
pub fn unbounded<T>() -> (Sender<T>, Receiver<T>) {
|
||||
let channel = Arc::new(Channel {
|
||||
queue: ConcurrentQueue::unbounded(),
|
||||
send_ops: Event::new(),
|
||||
recv_ops: Event::new(),
|
||||
stream_ops: Event::new(),
|
||||
sender_count: AtomicUsize::new(1),
|
||||
receiver_count: AtomicUsize::new(1),
|
||||
});
|
||||
|
||||
let s = Sender {
|
||||
channel: channel.clone(),
|
||||
};
|
||||
let r = Receiver {
|
||||
channel,
|
||||
listener: None,
|
||||
};
|
||||
(s, r)
|
||||
}
|
||||
|
||||
/// The sending side of a channel.
|
||||
///
|
||||
/// Senders can be cloned and shared among threads. When all senders associated with a channel are
|
||||
/// dropped, the channel becomes closed.
|
||||
pub struct Sender<T> {
|
||||
/// Inner channel state.
|
||||
channel: Arc<Channel<T>>,
|
||||
}
|
||||
|
||||
impl<T> Sender<T> {
|
||||
/// Attempts to send a message into the channel.
|
||||
///
|
||||
/// If the channel is full or closed, this method returns an error.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_channel::{bounded, TrySendError};
|
||||
///
|
||||
/// let (s, r) = bounded(1);
|
||||
///
|
||||
/// assert_eq!(s.try_send(1), Ok(()));
|
||||
/// assert_eq!(s.try_send(2), Err(TrySendError::Full(2)));
|
||||
///
|
||||
/// drop(r);
|
||||
/// assert_eq!(s.try_send(3), Err(TrySendError::Closed(3)));
|
||||
/// ```
|
||||
pub fn try_send(&self, msg: T) -> Result<(), TrySendError<T>> {
|
||||
match self.channel.queue.push(msg) {
|
||||
Ok(()) => {
|
||||
// Notify a single blocked receive operation. If the notified operation then
|
||||
// receives a message or gets canceled, it will notify another blocked receive
|
||||
// operation.
|
||||
self.channel.recv_ops.notify(1);
|
||||
|
||||
// Notify all blocked streams.
|
||||
self.channel.stream_ops.notify(usize::MAX);
|
||||
|
||||
Ok(())
|
||||
}
|
||||
Err(PushError::Full(msg)) => Err(TrySendError::Full(msg)),
|
||||
Err(PushError::Closed(msg)) => Err(TrySendError::Closed(msg)),
|
||||
}
|
||||
}
|
||||
|
||||
/// Sends a message into the channel.
|
||||
///
|
||||
/// If the channel is full, this method waits until there is space for a message.
|
||||
///
|
||||
/// If the channel is closed, this method returns an error.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// # blocking::block_on! {
|
||||
/// use async_channel::{unbounded, SendError};
|
||||
///
|
||||
/// let (s, r) = unbounded();
|
||||
///
|
||||
/// assert_eq!(s.send(1).await, Ok(()));
|
||||
/// drop(r);
|
||||
/// assert_eq!(s.send(2).await, Err(SendError(2)));
|
||||
/// # }
|
||||
/// ```
|
||||
pub async fn send(&self, msg: T) -> Result<(), SendError<T>> {
|
||||
let mut listener = None;
|
||||
let mut msg = msg;
|
||||
|
||||
loop {
|
||||
// Attempt to send a message.
|
||||
match self.try_send(msg) {
|
||||
Ok(()) => return Ok(()),
|
||||
Err(TrySendError::Closed(msg)) => return Err(SendError(msg)),
|
||||
Err(TrySendError::Full(m)) => msg = m,
|
||||
}
|
||||
|
||||
// Sending failed - now start listening for notifications or wait for one.
|
||||
match listener.take() {
|
||||
None => {
|
||||
// Start listening and then try receiving again.
|
||||
listener = Some(self.channel.send_ops.listen());
|
||||
}
|
||||
Some(l) => {
|
||||
// Wait for a notification.
|
||||
l.await;
|
||||
|
||||
// If the capacity is larger than 1, notify another blocked send operation.
|
||||
match self.channel.queue.capacity() {
|
||||
Some(1) => {}
|
||||
Some(_) | None => self.channel.send_ops.notify(1),
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns `true` if the channel is empty.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// # blocking::block_on! {
|
||||
/// use async_channel::unbounded;
|
||||
///
|
||||
/// let (s, r) = unbounded();
|
||||
///
|
||||
/// assert!(s.is_empty());
|
||||
/// s.send(1).await;
|
||||
/// assert!(!s.is_empty());
|
||||
/// # }
|
||||
/// ```
|
||||
pub fn is_empty(&self) -> bool {
|
||||
self.channel.queue.is_empty()
|
||||
}
|
||||
|
||||
/// Returns `true` if the channel is full.
|
||||
///
|
||||
/// Unbounded channels are never full.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// # blocking::block_on! {
|
||||
/// use async_channel::bounded;
|
||||
///
|
||||
/// let (s, r) = bounded(1);
|
||||
///
|
||||
/// assert!(!s.is_full());
|
||||
/// s.send(1).await;
|
||||
/// assert!(s.is_full());
|
||||
/// # }
|
||||
/// ```
|
||||
pub fn is_full(&self) -> bool {
|
||||
self.channel.queue.is_full()
|
||||
}
|
||||
|
||||
/// Returns the number of messages in the channel.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// # blocking::block_on! {
|
||||
/// use async_channel::unbounded;
|
||||
///
|
||||
/// let (s, r) = unbounded();
|
||||
/// assert_eq!(s.len(), 0);
|
||||
///
|
||||
/// s.send(1).await;
|
||||
/// s.send(2).await;
|
||||
/// assert_eq!(s.len(), 2);
|
||||
/// # }
|
||||
/// ```
|
||||
pub fn len(&self) -> usize {
|
||||
self.channel.queue.len()
|
||||
}
|
||||
|
||||
/// Returns the channel capacity if it's bounded.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_channel::{bounded, unbounded};
|
||||
///
|
||||
/// let (s, r) = bounded::<i32>(5);
|
||||
/// assert_eq!(s.capacity(), Some(5));
|
||||
///
|
||||
/// let (s, r) = unbounded::<i32>();
|
||||
/// assert_eq!(s.capacity(), None);
|
||||
/// ```
|
||||
pub fn capacity(&self) -> Option<usize> {
|
||||
self.channel.queue.capacity()
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> Drop for Sender<T> {
|
||||
fn drop(&mut self) {
|
||||
// Decrement the sender count and close the channel if it drops down to zero.
|
||||
if self.channel.sender_count.fetch_sub(1, Ordering::AcqRel) == 1 {
|
||||
self.channel.close();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> fmt::Debug for Sender<T> {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
write!(f, "Sender {{ .. }}")
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> Clone for Sender<T> {
|
||||
fn clone(&self) -> Sender<T> {
|
||||
let count = self.channel.sender_count.fetch_add(1, Ordering::Relaxed);
|
||||
|
||||
// Make sure the count never overflows, even if lots of sender clones are leaked.
|
||||
if count > usize::MAX / 2 {
|
||||
process::abort();
|
||||
}
|
||||
|
||||
Sender {
|
||||
channel: self.channel.clone(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The receiving side of a channel.
|
||||
///
|
||||
/// Receivers can be cloned and shared among threads. When all receivers associated with a channel
|
||||
/// are dropped, the channel becomes closed.
|
||||
///
|
||||
/// Receivers implement the [`Stream`] trait.
|
||||
pub struct Receiver<T> {
|
||||
/// Inner channel state.
|
||||
channel: Arc<Channel<T>>,
|
||||
|
||||
/// Listens for a send or close event to unblock this stream.
|
||||
listener: Option<EventListener>,
|
||||
}
|
||||
|
||||
impl<T> Receiver<T> {
|
||||
/// Attempts to receive a message from the channel.
|
||||
///
|
||||
/// If the channel is empty or closed, this method returns an error.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// # blocking::block_on! {
|
||||
/// use async_channel::{unbounded, TryRecvError};
|
||||
///
|
||||
/// let (s, r) = unbounded();
|
||||
/// assert_eq!(s.send(1).await, Ok(()));
|
||||
///
|
||||
/// assert_eq!(r.try_recv(), Ok(1));
|
||||
/// assert_eq!(r.try_recv(), Err(TryRecvError::Empty));
|
||||
///
|
||||
/// drop(s);
|
||||
/// assert_eq!(r.try_recv(), Err(TryRecvError::Closed));
|
||||
/// # }
|
||||
/// ```
|
||||
pub fn try_recv(&self) -> Result<T, TryRecvError> {
|
||||
match self.channel.queue.pop() {
|
||||
Ok(msg) => {
|
||||
// Notify a single blocked send operation. If the notified operation then sends a
|
||||
// message or gets canceled, it will notify another blocked send operation.
|
||||
self.channel.send_ops.notify(1);
|
||||
|
||||
Ok(msg)
|
||||
}
|
||||
Err(PopError::Empty) => Err(TryRecvError::Empty),
|
||||
Err(PopError::Closed) => Err(TryRecvError::Closed),
|
||||
}
|
||||
}
|
||||
|
||||
/// Receives a message from the channel.
|
||||
///
|
||||
/// If the channel is empty, this method waits until there is a message.
|
||||
///
|
||||
/// If the channel is closed, this method receives a message or returns an error if there are
|
||||
/// no more messages.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// # blocking::block_on! {
|
||||
/// use async_channel::{unbounded, RecvError};
|
||||
///
|
||||
/// let (s, r) = unbounded();
|
||||
///
|
||||
/// assert_eq!(s.send(1).await, Ok(()));
|
||||
/// drop(s);
|
||||
///
|
||||
/// assert_eq!(r.recv().await, Ok(1));
|
||||
/// assert_eq!(r.recv().await, Err(RecvError));
|
||||
/// # }
|
||||
/// ```
|
||||
pub async fn recv(&self) -> Result<T, RecvError> {
|
||||
let mut listener = None;
|
||||
|
||||
loop {
|
||||
// Attempt to receive a message.
|
||||
match self.try_recv() {
|
||||
Ok(msg) => return Ok(msg),
|
||||
Err(TryRecvError::Closed) => return Err(RecvError),
|
||||
Err(TryRecvError::Empty) => {}
|
||||
}
|
||||
|
||||
// Receiving failed - now start listening for notifications or wait for one.
|
||||
match listener.take() {
|
||||
None => {
|
||||
// Start listening and then try receiving again.
|
||||
listener = Some(self.channel.recv_ops.listen());
|
||||
}
|
||||
Some(l) => {
|
||||
// Wait for a notification.
|
||||
l.await;
|
||||
|
||||
// If the capacity is larger than 1, notify another blocked receive operation.
|
||||
// There is no need to notify stream operations because all of them get
|
||||
// notified every time a message is sent into the channel.
|
||||
match self.channel.queue.capacity() {
|
||||
Some(1) => {}
|
||||
Some(_) | None => self.channel.recv_ops.notify(1),
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns `true` if the channel is empty.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// # blocking::block_on! {
|
||||
/// use async_channel::unbounded;
|
||||
///
|
||||
/// let (s, r) = unbounded();
|
||||
///
|
||||
/// assert!(s.is_empty());
|
||||
/// s.send(1).await;
|
||||
/// assert!(!s.is_empty());
|
||||
/// # }
|
||||
/// ```
|
||||
pub fn is_empty(&self) -> bool {
|
||||
self.channel.queue.is_empty()
|
||||
}
|
||||
|
||||
/// Returns `true` if the channel is full.
|
||||
///
|
||||
/// Unbounded channels are never full.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// # blocking::block_on! {
|
||||
/// use async_channel::bounded;
|
||||
///
|
||||
/// let (s, r) = bounded(1);
|
||||
///
|
||||
/// assert!(!r.is_full());
|
||||
/// s.send(1).await;
|
||||
/// assert!(r.is_full());
|
||||
/// # }
|
||||
/// ```
|
||||
pub fn is_full(&self) -> bool {
|
||||
self.channel.queue.is_full()
|
||||
}
|
||||
|
||||
/// Returns the number of messages in the channel.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// # blocking::block_on! {
|
||||
/// use async_channel::unbounded;
|
||||
///
|
||||
/// let (s, r) = unbounded();
|
||||
/// assert_eq!(r.len(), 0);
|
||||
///
|
||||
/// s.send(1).await;
|
||||
/// s.send(2).await;
|
||||
/// assert_eq!(r.len(), 2);
|
||||
/// # }
|
||||
/// ```
|
||||
pub fn len(&self) -> usize {
|
||||
self.channel.queue.len()
|
||||
}
|
||||
|
||||
/// Returns the channel capacity if it's bounded.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_channel::{bounded, unbounded};
|
||||
///
|
||||
/// let (s, r) = bounded::<i32>(5);
|
||||
/// assert_eq!(r.capacity(), Some(5));
|
||||
///
|
||||
/// let (s, r) = unbounded::<i32>();
|
||||
/// assert_eq!(r.capacity(), None);
|
||||
/// ```
|
||||
pub fn capacity(&self) -> Option<usize> {
|
||||
self.channel.queue.capacity()
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> Drop for Receiver<T> {
|
||||
fn drop(&mut self) {
|
||||
// Decrement the receiver count and close the channel if it drops down to zero.
|
||||
if self.channel.receiver_count.fetch_sub(1, Ordering::AcqRel) == 1 {
|
||||
self.channel.close();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> fmt::Debug for Receiver<T> {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
write!(f, "Receiver {{ .. }}")
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> Clone for Receiver<T> {
|
||||
fn clone(&self) -> Receiver<T> {
|
||||
let count = self.channel.receiver_count.fetch_add(1, Ordering::Relaxed);
|
||||
|
||||
// Make sure the count never overflows, even if lots of receiver clones are leaked.
|
||||
if count > usize::MAX / 2 {
|
||||
process::abort();
|
||||
}
|
||||
|
||||
Receiver {
|
||||
channel: self.channel.clone(),
|
||||
listener: None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> Stream for Receiver<T> {
|
||||
type Item = T;
|
||||
|
||||
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
|
||||
loop {
|
||||
// If this stream is listening for events, first wait for a notification.
|
||||
if let Some(listener) = self.listener.as_mut() {
|
||||
futures_core::ready!(Pin::new(listener).poll(cx));
|
||||
self.listener = None;
|
||||
}
|
||||
|
||||
loop {
|
||||
// Attempt to receive a message.
|
||||
match self.try_recv() {
|
||||
Ok(msg) => {
|
||||
// The stream is not blocked on an event - drop the listener.
|
||||
self.listener = None;
|
||||
return Poll::Ready(Some(msg));
|
||||
}
|
||||
Err(TryRecvError::Closed) => {
|
||||
// The stream is not blocked on an event - drop the listener.
|
||||
self.listener = None;
|
||||
return Poll::Ready(None);
|
||||
}
|
||||
Err(TryRecvError::Empty) => {}
|
||||
}
|
||||
|
||||
// Receiving failed - now start listening for notifications or wait for one.
|
||||
match self.listener.as_mut() {
|
||||
None => {
|
||||
// Create a listener and try sending the message again.
|
||||
self.listener = Some(self.channel.stream_ops.listen());
|
||||
}
|
||||
Some(_) => {
|
||||
// Go back to the outer loop to poll the listener.
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// An error returned from [`Sender::send()`].
|
||||
///
|
||||
/// Received because the channel is closed.
|
||||
#[derive(PartialEq, Eq, Clone, Copy)]
|
||||
pub struct SendError<T>(pub T);
|
||||
|
||||
impl<T> error::Error for SendError<T> {}
|
||||
|
||||
impl<T> fmt::Debug for SendError<T> {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
write!(f, "SendError(..)")
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> fmt::Display for SendError<T> {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
write!(f, "sending into a closed channel")
|
||||
}
|
||||
}
|
||||
|
||||
/// An error returned from [`Sender::try_send()`].
|
||||
#[derive(PartialEq, Eq, Clone, Copy)]
|
||||
pub enum TrySendError<T> {
|
||||
/// The channel is full but not closed.
|
||||
Full(T),
|
||||
|
||||
/// The channel is closed.
|
||||
Closed(T),
|
||||
}
|
||||
|
||||
impl<T> error::Error for TrySendError<T> {}
|
||||
|
||||
impl<T> fmt::Debug for TrySendError<T> {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
match *self {
|
||||
TrySendError::Full(..) => write!(f, "Full(..)"),
|
||||
TrySendError::Closed(..) => write!(f, "Closed(..)"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> fmt::Display for TrySendError<T> {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
match *self {
|
||||
TrySendError::Full(..) => write!(f, "sending into a full channel"),
|
||||
TrySendError::Closed(..) => write!(f, "sending into a closed channel"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// An error returned from [`Receiver::recv()`].
|
||||
///
|
||||
/// Received because the channel is empty and closed.
|
||||
#[derive(PartialEq, Eq, Clone, Copy, Debug)]
|
||||
pub struct RecvError;
|
||||
|
||||
impl error::Error for RecvError {}
|
||||
|
||||
impl fmt::Display for RecvError {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
write!(f, "receiving from an empty and closed channel")
|
||||
}
|
||||
}
|
||||
|
||||
/// An error returned from [`Receiver::try_recv()`].
|
||||
#[derive(PartialEq, Eq, Clone, Copy, Debug)]
|
||||
pub enum TryRecvError {
|
||||
/// The channel is empty but not closed.
|
||||
Empty,
|
||||
|
||||
/// The channel is empty and closed.
|
||||
Closed,
|
||||
}
|
||||
|
||||
impl error::Error for TryRecvError {}
|
||||
|
||||
impl fmt::Display for TryRecvError {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
match *self {
|
||||
TryRecvError::Empty => write!(f, "receiving from an empty channel"),
|
||||
TryRecvError::Closed => write!(f, "receiving from an empty and closed channel"),
|
||||
}
|
||||
}
|
||||
}
|
|
@ -0,0 +1,358 @@
|
|||
use std::sync::atomic::{AtomicUsize, Ordering};
|
||||
use std::thread::sleep;
|
||||
use std::time::Duration;
|
||||
|
||||
use async_channel::{bounded, RecvError, SendError, TryRecvError, TrySendError};
|
||||
use blocking::block_on;
|
||||
use easy_parallel::Parallel;
|
||||
use futures_util::stream::StreamExt;
|
||||
|
||||
fn ms(ms: u64) -> Duration {
|
||||
Duration::from_millis(ms)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn smoke() {
|
||||
let (s, r) = bounded(1);
|
||||
|
||||
block_on(s.send(7)).unwrap();
|
||||
assert_eq!(r.try_recv(), Ok(7));
|
||||
|
||||
block_on(s.send(8)).unwrap();
|
||||
assert_eq!(block_on(r.recv()), Ok(8));
|
||||
|
||||
assert_eq!(r.try_recv(), Err(TryRecvError::Empty));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn capacity() {
|
||||
for i in 1..10 {
|
||||
let (s, r) = bounded::<()>(i);
|
||||
assert_eq!(s.capacity(), Some(i));
|
||||
assert_eq!(r.capacity(), Some(i));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn len_empty_full() {
|
||||
let (s, r) = bounded(2);
|
||||
|
||||
assert_eq!(s.len(), 0);
|
||||
assert_eq!(s.is_empty(), true);
|
||||
assert_eq!(s.is_full(), false);
|
||||
assert_eq!(r.len(), 0);
|
||||
assert_eq!(r.is_empty(), true);
|
||||
assert_eq!(r.is_full(), false);
|
||||
|
||||
block_on(s.send(())).unwrap();
|
||||
|
||||
assert_eq!(s.len(), 1);
|
||||
assert_eq!(s.is_empty(), false);
|
||||
assert_eq!(s.is_full(), false);
|
||||
assert_eq!(r.len(), 1);
|
||||
assert_eq!(r.is_empty(), false);
|
||||
assert_eq!(r.is_full(), false);
|
||||
|
||||
block_on(s.send(())).unwrap();
|
||||
|
||||
assert_eq!(s.len(), 2);
|
||||
assert_eq!(s.is_empty(), false);
|
||||
assert_eq!(s.is_full(), true);
|
||||
assert_eq!(r.len(), 2);
|
||||
assert_eq!(r.is_empty(), false);
|
||||
assert_eq!(r.is_full(), true);
|
||||
|
||||
block_on(r.recv()).unwrap();
|
||||
|
||||
assert_eq!(s.len(), 1);
|
||||
assert_eq!(s.is_empty(), false);
|
||||
assert_eq!(s.is_full(), false);
|
||||
assert_eq!(r.len(), 1);
|
||||
assert_eq!(r.is_empty(), false);
|
||||
assert_eq!(r.is_full(), false);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn try_recv() {
|
||||
let (s, r) = bounded(100);
|
||||
|
||||
Parallel::new()
|
||||
.add(move || {
|
||||
assert_eq!(r.try_recv(), Err(TryRecvError::Empty));
|
||||
sleep(ms(1500));
|
||||
assert_eq!(r.try_recv(), Ok(7));
|
||||
sleep(ms(500));
|
||||
assert_eq!(r.try_recv(), Err(TryRecvError::Closed));
|
||||
})
|
||||
.add(move || {
|
||||
sleep(ms(1000));
|
||||
block_on(s.send(7)).unwrap();
|
||||
})
|
||||
.run();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn recv() {
|
||||
let (s, r) = bounded(100);
|
||||
|
||||
Parallel::new()
|
||||
.add(move || {
|
||||
assert_eq!(block_on(r.recv()), Ok(7));
|
||||
sleep(ms(1000));
|
||||
assert_eq!(block_on(r.recv()), Ok(8));
|
||||
sleep(ms(1000));
|
||||
assert_eq!(block_on(r.recv()), Ok(9));
|
||||
assert_eq!(block_on(r.recv()), Err(RecvError));
|
||||
})
|
||||
.add(move || {
|
||||
sleep(ms(1500));
|
||||
block_on(s.send(7)).unwrap();
|
||||
block_on(s.send(8)).unwrap();
|
||||
block_on(s.send(9)).unwrap();
|
||||
})
|
||||
.run();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn try_send() {
|
||||
let (s, r) = bounded(1);
|
||||
|
||||
Parallel::new()
|
||||
.add(move || {
|
||||
assert_eq!(s.try_send(1), Ok(()));
|
||||
assert_eq!(s.try_send(2), Err(TrySendError::Full(2)));
|
||||
sleep(ms(1500));
|
||||
assert_eq!(s.try_send(3), Ok(()));
|
||||
sleep(ms(500));
|
||||
assert_eq!(s.try_send(4), Err(TrySendError::Closed(4)));
|
||||
})
|
||||
.add(move || {
|
||||
sleep(ms(1000));
|
||||
assert_eq!(r.try_recv(), Ok(1));
|
||||
assert_eq!(r.try_recv(), Err(TryRecvError::Empty));
|
||||
assert_eq!(block_on(r.recv()), Ok(3));
|
||||
})
|
||||
.run();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn send() {
|
||||
let (s, r) = bounded(1);
|
||||
|
||||
Parallel::new()
|
||||
.add(|| {
|
||||
block_on(s.send(7)).unwrap();
|
||||
sleep(ms(1000));
|
||||
block_on(s.send(8)).unwrap();
|
||||
sleep(ms(1000));
|
||||
block_on(s.send(9)).unwrap();
|
||||
sleep(ms(1000));
|
||||
block_on(s.send(10)).unwrap();
|
||||
})
|
||||
.add(|| {
|
||||
sleep(ms(1500));
|
||||
assert_eq!(block_on(r.recv()), Ok(7));
|
||||
assert_eq!(block_on(r.recv()), Ok(8));
|
||||
assert_eq!(block_on(r.recv()), Ok(9));
|
||||
})
|
||||
.run();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn send_after_close() {
|
||||
let (s, r) = bounded(100);
|
||||
|
||||
block_on(s.send(1)).unwrap();
|
||||
block_on(s.send(2)).unwrap();
|
||||
block_on(s.send(3)).unwrap();
|
||||
|
||||
drop(r);
|
||||
|
||||
assert_eq!(block_on(s.send(4)), Err(SendError(4)));
|
||||
assert_eq!(s.try_send(5), Err(TrySendError::Closed(5)));
|
||||
assert_eq!(block_on(s.send(6)), Err(SendError(6)));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn recv_after_close() {
|
||||
let (s, r) = bounded(100);
|
||||
|
||||
block_on(s.send(1)).unwrap();
|
||||
block_on(s.send(2)).unwrap();
|
||||
block_on(s.send(3)).unwrap();
|
||||
|
||||
drop(s);
|
||||
|
||||
assert_eq!(block_on(r.recv()), Ok(1));
|
||||
assert_eq!(block_on(r.recv()), Ok(2));
|
||||
assert_eq!(block_on(r.recv()), Ok(3));
|
||||
assert_eq!(block_on(r.recv()), Err(RecvError));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn len() {
|
||||
const COUNT: usize = 25_000;
|
||||
const CAP: usize = 1000;
|
||||
|
||||
let (s, r) = bounded(CAP);
|
||||
|
||||
assert_eq!(s.len(), 0);
|
||||
assert_eq!(r.len(), 0);
|
||||
|
||||
for _ in 0..CAP / 10 {
|
||||
for i in 0..50 {
|
||||
block_on(s.send(i)).unwrap();
|
||||
assert_eq!(s.len(), i + 1);
|
||||
}
|
||||
|
||||
for i in 0..50 {
|
||||
block_on(r.recv()).unwrap();
|
||||
assert_eq!(r.len(), 50 - i - 1);
|
||||
}
|
||||
}
|
||||
|
||||
assert_eq!(s.len(), 0);
|
||||
assert_eq!(r.len(), 0);
|
||||
|
||||
for i in 0..CAP {
|
||||
block_on(s.send(i)).unwrap();
|
||||
assert_eq!(s.len(), i + 1);
|
||||
}
|
||||
|
||||
for _ in 0..CAP {
|
||||
block_on(r.recv()).unwrap();
|
||||
}
|
||||
|
||||
assert_eq!(s.len(), 0);
|
||||
assert_eq!(r.len(), 0);
|
||||
|
||||
Parallel::new()
|
||||
.add(|| {
|
||||
for i in 0..COUNT {
|
||||
assert_eq!(block_on(r.recv()), Ok(i));
|
||||
let len = r.len();
|
||||
assert!(len <= CAP);
|
||||
}
|
||||
})
|
||||
.add(|| {
|
||||
for i in 0..COUNT {
|
||||
block_on(s.send(i)).unwrap();
|
||||
let len = s.len();
|
||||
assert!(len <= CAP);
|
||||
}
|
||||
})
|
||||
.run();
|
||||
|
||||
assert_eq!(s.len(), 0);
|
||||
assert_eq!(r.len(), 0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn close_wakes_sender() {
|
||||
let (s, r) = bounded(1);
|
||||
|
||||
Parallel::new()
|
||||
.add(move || {
|
||||
assert_eq!(block_on(s.send(())), Ok(()));
|
||||
assert_eq!(block_on(s.send(())), Err(SendError(())));
|
||||
})
|
||||
.add(move || {
|
||||
sleep(ms(1000));
|
||||
drop(r);
|
||||
})
|
||||
.run();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn close_wakes_receiver() {
|
||||
let (s, r) = bounded::<()>(1);
|
||||
|
||||
Parallel::new()
|
||||
.add(move || {
|
||||
assert_eq!(block_on(r.recv()), Err(RecvError));
|
||||
})
|
||||
.add(move || {
|
||||
sleep(ms(1000));
|
||||
drop(s);
|
||||
})
|
||||
.run();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn spsc() {
|
||||
const COUNT: usize = 100_000;
|
||||
|
||||
let (s, r) = bounded(3);
|
||||
|
||||
Parallel::new()
|
||||
.add(move || {
|
||||
for i in 0..COUNT {
|
||||
assert_eq!(block_on(r.recv()), Ok(i));
|
||||
}
|
||||
assert_eq!(block_on(r.recv()), Err(RecvError));
|
||||
})
|
||||
.add(move || {
|
||||
for i in 0..COUNT {
|
||||
block_on(s.send(i)).unwrap();
|
||||
}
|
||||
})
|
||||
.run();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn mpmc() {
|
||||
const COUNT: usize = 25_000;
|
||||
const THREADS: usize = 4;
|
||||
|
||||
let (s, r) = bounded::<usize>(3);
|
||||
let v = (0..COUNT).map(|_| AtomicUsize::new(0)).collect::<Vec<_>>();
|
||||
|
||||
Parallel::new()
|
||||
.each(0..THREADS, |_| {
|
||||
for _ in 0..COUNT {
|
||||
let n = block_on(r.recv()).unwrap();
|
||||
v[n].fetch_add(1, Ordering::SeqCst);
|
||||
}
|
||||
})
|
||||
.each(0..THREADS, |_| {
|
||||
for i in 0..COUNT {
|
||||
block_on(s.send(i)).unwrap();
|
||||
}
|
||||
})
|
||||
.run();
|
||||
|
||||
for c in v {
|
||||
assert_eq!(c.load(Ordering::SeqCst), THREADS);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn mpmc_stream() {
|
||||
const COUNT: usize = 25_000;
|
||||
const THREADS: usize = 4;
|
||||
|
||||
let (s, r) = bounded::<usize>(3);
|
||||
let v = (0..COUNT).map(|_| AtomicUsize::new(0)).collect::<Vec<_>>();
|
||||
let v = &v;
|
||||
|
||||
Parallel::new()
|
||||
.each(0..THREADS, {
|
||||
let mut r = r.clone();
|
||||
move |_| {
|
||||
for _ in 0..COUNT {
|
||||
let n = block_on(r.next()).unwrap();
|
||||
v[n].fetch_add(1, Ordering::SeqCst);
|
||||
}
|
||||
}
|
||||
})
|
||||
.each(0..THREADS, |_| {
|
||||
for i in 0..COUNT {
|
||||
block_on(s.send(i)).unwrap();
|
||||
}
|
||||
})
|
||||
.run();
|
||||
|
||||
for c in v {
|
||||
assert_eq!(c.load(Ordering::SeqCst), THREADS);
|
||||
}
|
||||
}
|
|
@ -0,0 +1,273 @@
|
|||
use std::sync::atomic::{AtomicUsize, Ordering};
|
||||
use std::thread::sleep;
|
||||
use std::time::Duration;
|
||||
|
||||
use async_channel::{unbounded, RecvError, SendError, TryRecvError, TrySendError};
|
||||
use blocking::block_on;
|
||||
use easy_parallel::Parallel;
|
||||
use futures_util::stream::StreamExt;
|
||||
|
||||
fn ms(ms: u64) -> Duration {
|
||||
Duration::from_millis(ms)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn smoke() {
|
||||
let (s, r) = unbounded();
|
||||
|
||||
s.try_send(7).unwrap();
|
||||
assert_eq!(r.try_recv(), Ok(7));
|
||||
|
||||
block_on(s.send(8)).unwrap();
|
||||
assert_eq!(block_on(r.recv()), Ok(8));
|
||||
assert_eq!(r.try_recv(), Err(TryRecvError::Empty));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn capacity() {
|
||||
let (s, r) = unbounded::<()>();
|
||||
assert_eq!(s.capacity(), None);
|
||||
assert_eq!(r.capacity(), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn len_empty_full() {
|
||||
let (s, r) = unbounded();
|
||||
|
||||
assert_eq!(s.len(), 0);
|
||||
assert_eq!(s.is_empty(), true);
|
||||
assert_eq!(s.is_full(), false);
|
||||
assert_eq!(r.len(), 0);
|
||||
assert_eq!(r.is_empty(), true);
|
||||
assert_eq!(r.is_full(), false);
|
||||
|
||||
block_on(s.send(())).unwrap();
|
||||
|
||||
assert_eq!(s.len(), 1);
|
||||
assert_eq!(s.is_empty(), false);
|
||||
assert_eq!(s.is_full(), false);
|
||||
assert_eq!(r.len(), 1);
|
||||
assert_eq!(r.is_empty(), false);
|
||||
assert_eq!(r.is_full(), false);
|
||||
|
||||
block_on(r.recv()).unwrap();
|
||||
|
||||
assert_eq!(s.len(), 0);
|
||||
assert_eq!(s.is_empty(), true);
|
||||
assert_eq!(s.is_full(), false);
|
||||
assert_eq!(r.len(), 0);
|
||||
assert_eq!(r.is_empty(), true);
|
||||
assert_eq!(r.is_full(), false);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn try_recv() {
|
||||
let (s, r) = unbounded();
|
||||
|
||||
Parallel::new()
|
||||
.add(move || {
|
||||
assert_eq!(r.try_recv(), Err(TryRecvError::Empty));
|
||||
sleep(ms(1500));
|
||||
assert_eq!(r.try_recv(), Ok(7));
|
||||
sleep(ms(500));
|
||||
assert_eq!(r.try_recv(), Err(TryRecvError::Closed));
|
||||
})
|
||||
.add(move || {
|
||||
sleep(ms(1000));
|
||||
block_on(s.send(7)).unwrap();
|
||||
})
|
||||
.run();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn recv() {
|
||||
let (s, r) = unbounded();
|
||||
|
||||
Parallel::new()
|
||||
.add(move || {
|
||||
assert_eq!(block_on(r.recv()), Ok(7));
|
||||
sleep(ms(1000));
|
||||
assert_eq!(block_on(r.recv()), Ok(8));
|
||||
sleep(ms(1000));
|
||||
assert_eq!(block_on(r.recv()), Ok(9));
|
||||
assert_eq!(block_on(r.recv()), Err(RecvError));
|
||||
})
|
||||
.add(move || {
|
||||
sleep(ms(1500));
|
||||
block_on(s.send(7)).unwrap();
|
||||
block_on(s.send(8)).unwrap();
|
||||
block_on(s.send(9)).unwrap();
|
||||
})
|
||||
.run();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn try_send() {
|
||||
let (s, r) = unbounded();
|
||||
for i in 0..1000 {
|
||||
assert_eq!(s.try_send(i), Ok(()));
|
||||
}
|
||||
|
||||
drop(r);
|
||||
assert_eq!(s.try_send(777), Err(TrySendError::Closed(777)));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn send() {
|
||||
let (s, r) = unbounded();
|
||||
for i in 0..1000 {
|
||||
assert_eq!(block_on(s.send(i)), Ok(()));
|
||||
}
|
||||
|
||||
drop(r);
|
||||
assert_eq!(block_on(s.send(777)), Err(SendError(777)));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn send_after_close() {
|
||||
let (s, r) = unbounded();
|
||||
|
||||
block_on(s.send(1)).unwrap();
|
||||
block_on(s.send(2)).unwrap();
|
||||
block_on(s.send(3)).unwrap();
|
||||
|
||||
drop(r);
|
||||
|
||||
assert_eq!(block_on(s.send(4)), Err(SendError(4)));
|
||||
assert_eq!(s.try_send(5), Err(TrySendError::Closed(5)));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn recv_after_close() {
|
||||
let (s, r) = unbounded();
|
||||
|
||||
block_on(s.send(1)).unwrap();
|
||||
block_on(s.send(2)).unwrap();
|
||||
block_on(s.send(3)).unwrap();
|
||||
|
||||
drop(s);
|
||||
|
||||
assert_eq!(block_on(r.recv()), Ok(1));
|
||||
assert_eq!(block_on(r.recv()), Ok(2));
|
||||
assert_eq!(block_on(r.recv()), Ok(3));
|
||||
assert_eq!(block_on(r.recv()), Err(RecvError));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn len() {
|
||||
let (s, r) = unbounded();
|
||||
|
||||
assert_eq!(s.len(), 0);
|
||||
assert_eq!(r.len(), 0);
|
||||
|
||||
for i in 0..50 {
|
||||
block_on(s.send(i)).unwrap();
|
||||
assert_eq!(s.len(), i + 1);
|
||||
}
|
||||
|
||||
for i in 0..50 {
|
||||
block_on(r.recv()).unwrap();
|
||||
assert_eq!(r.len(), 50 - i - 1);
|
||||
}
|
||||
|
||||
assert_eq!(s.len(), 0);
|
||||
assert_eq!(r.len(), 0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn close_wakes_receiver() {
|
||||
let (s, r) = unbounded::<()>();
|
||||
|
||||
Parallel::new()
|
||||
.add(move || {
|
||||
assert_eq!(block_on(r.recv()), Err(RecvError));
|
||||
})
|
||||
.add(move || {
|
||||
sleep(ms(1000));
|
||||
drop(s);
|
||||
})
|
||||
.run();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn spsc() {
|
||||
const COUNT: usize = 100_000;
|
||||
|
||||
let (s, r) = unbounded();
|
||||
|
||||
Parallel::new()
|
||||
.add(move || {
|
||||
for i in 0..COUNT {
|
||||
assert_eq!(block_on(r.recv()), Ok(i));
|
||||
}
|
||||
assert_eq!(block_on(r.recv()), Err(RecvError));
|
||||
})
|
||||
.add(move || {
|
||||
for i in 0..COUNT {
|
||||
block_on(s.send(i)).unwrap();
|
||||
}
|
||||
})
|
||||
.run();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn mpmc() {
|
||||
const COUNT: usize = 25_000;
|
||||
const THREADS: usize = 4;
|
||||
|
||||
let (s, r) = unbounded::<usize>();
|
||||
let v = (0..COUNT).map(|_| AtomicUsize::new(0)).collect::<Vec<_>>();
|
||||
|
||||
Parallel::new()
|
||||
.each(0..THREADS, |_| {
|
||||
for _ in 0..COUNT {
|
||||
let n = block_on(r.recv()).unwrap();
|
||||
v[n].fetch_add(1, Ordering::SeqCst);
|
||||
}
|
||||
})
|
||||
.each(0..THREADS, |_| {
|
||||
for i in 0..COUNT {
|
||||
block_on(s.send(i)).unwrap();
|
||||
}
|
||||
})
|
||||
.run();
|
||||
|
||||
assert_eq!(r.try_recv(), Err(TryRecvError::Empty));
|
||||
|
||||
for c in v {
|
||||
assert_eq!(c.load(Ordering::SeqCst), THREADS);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn mpmc_stream() {
|
||||
const COUNT: usize = 25_000;
|
||||
const THREADS: usize = 4;
|
||||
|
||||
let (s, r) = unbounded::<usize>();
|
||||
let v = (0..COUNT).map(|_| AtomicUsize::new(0)).collect::<Vec<_>>();
|
||||
let v = &v;
|
||||
|
||||
Parallel::new()
|
||||
.each(0..THREADS, {
|
||||
let mut r = r.clone();
|
||||
move |_| {
|
||||
for _ in 0..COUNT {
|
||||
let n = block_on(r.next()).unwrap();
|
||||
v[n].fetch_add(1, Ordering::SeqCst);
|
||||
}
|
||||
}
|
||||
})
|
||||
.each(0..THREADS, |_| {
|
||||
for i in 0..COUNT {
|
||||
block_on(s.send(i)).unwrap();
|
||||
}
|
||||
})
|
||||
.run();
|
||||
|
||||
assert_eq!(r.try_recv(), Err(TryRecvError::Empty));
|
||||
|
||||
for c in v {
|
||||
assert_eq!(c.load(Ordering::SeqCst), THREADS);
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue