Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: new channels #915

Merged
merged 3 commits into from
Dec 4, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ std = [
"wasm-bindgen-futures",
"futures-channel",
"async-mutex",
"async-channel",
]
alloc = [
"futures-core/alloc",
Expand All @@ -74,10 +75,12 @@ once_cell = { version = "1.3.1", optional = true }
pin-project-lite = { version = "0.2.0", optional = true }
pin-utils = { version = "0.1.0-alpha.4", optional = true }
slab = { version = "0.4.2", optional = true }
async-channel = { version = "1.5.1", optional = true }

# Devdepencency, but they are not allowed to be optional :/
surf = { version = "2.0.0", optional = true }


[target.'cfg(not(target_os = "unknown"))'.dependencies]
async-global-executor = { version = "1.4.0", optional = true, features = ["async-io"] }
async-io = { version = "1.0.1", optional = true }
Expand Down
6 changes: 6 additions & 0 deletions src/channel.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//! Channels

#[cfg(feature = "unstable")]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
#[doc(inline)]
pub use async_channel::*;
6 changes: 3 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -106,15 +106,14 @@
//! [`io`], [`fs`], and [`net`] modules.
//!
//! The [`task`] module contains `async-std`'s task abstractions. [`sync`]
//! contains further primitive shared memory types, including [`channel`],
//! which contains the channel types for message passing.
//! contains further primitive shared memory types. [`channel`] contains the channel types for message passing.
//!
//! [files]: fs/struct.File.html
//! [TCP]: net/struct.TcpStream.html
//! [UDP]: net/struct.UdpSocket.html
//! [`io`]: fs/struct.File.html
//! [`sync`]: sync/index.html
//! [`channel`]: sync/fn.channel.html
//! [`channel`]: channel/index.html
//!
//! ## Timeouts, intervals, and delays
//!
Expand Down Expand Up @@ -300,6 +299,7 @@ cfg_std! {
pub mod os;
pub mod prelude;
pub mod sync;
pub mod channel;
}

cfg_default! {
Expand Down
23 changes: 23 additions & 0 deletions src/sync/channel.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#![allow(deprecated)]

use std::cell::UnsafeCell;
use std::error::Error;
use std::fmt::{self, Debug, Display};
Expand Down Expand Up @@ -32,6 +34,7 @@ use crate::sync::WakerSet;
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// # fn main() -> Result<(), async_std::sync::RecvError> {
/// # async_std::task::block_on(async {
/// #
Expand Down Expand Up @@ -60,6 +63,7 @@ use crate::sync::WakerSet;
/// ```
#[cfg(feature = "unstable")]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
#[deprecated = "new channel api at async_std::channel"]
pub fn channel<T>(cap: usize) -> (Sender<T>, Receiver<T>) {
let channel = Arc::new(Channel::with_capacity(cap));
let s = Sender {
Expand All @@ -82,6 +86,7 @@ pub fn channel<T>(cap: usize) -> (Sender<T>, Receiver<T>) {
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// # async_std::task::block_on(async {
/// #
/// use async_std::sync::channel;
Expand All @@ -102,6 +107,7 @@ pub fn channel<T>(cap: usize) -> (Sender<T>, Receiver<T>) {
/// ```
#[cfg(feature = "unstable")]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
#[deprecated = "new channel api at async_std::channel"]
pub struct Sender<T> {
/// The inner channel.
channel: Arc<Channel<T>>,
Expand All @@ -115,6 +121,7 @@ impl<T> Sender<T> {
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// # fn main() -> Result<(), async_std::sync::RecvError> {
/// # async_std::task::block_on(async {
/// #
Expand Down Expand Up @@ -204,6 +211,7 @@ impl<T> Sender<T> {
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// # async_std::task::block_on(async {
/// #
/// use async_std::sync::channel;
Expand All @@ -223,6 +231,7 @@ impl<T> Sender<T> {
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// use async_std::sync::channel;
///
/// let (s, _) = channel::<i32>(5);
Expand All @@ -237,6 +246,7 @@ impl<T> Sender<T> {
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// # async_std::task::block_on(async {
/// #
/// use async_std::sync::channel;
Expand All @@ -258,6 +268,7 @@ impl<T> Sender<T> {
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// # async_std::task::block_on(async {
/// #
/// use async_std::sync::channel;
Expand All @@ -279,6 +290,7 @@ impl<T> Sender<T> {
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// # async_std::task::block_on(async {
/// #
/// use async_std::sync::channel;
Expand Down Expand Up @@ -339,6 +351,7 @@ impl<T> fmt::Debug for Sender<T> {
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// # fn main() -> Result<(), async_std::sync::RecvError> {
/// # async_std::task::block_on(async {
/// #
Expand All @@ -363,6 +376,7 @@ impl<T> fmt::Debug for Sender<T> {
/// ```
#[cfg(feature = "unstable")]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
#[deprecated = "new channel api at async_std::channel"]
pub struct Receiver<T> {
/// The inner channel.
channel: Arc<Channel<T>>,
Expand All @@ -381,6 +395,7 @@ impl<T> Receiver<T> {
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// # fn main() -> Result<(), async_std::sync::RecvError> {
/// # async_std::task::block_on(async {
/// #
Expand Down Expand Up @@ -444,6 +459,7 @@ impl<T> Receiver<T> {
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// # async_std::task::block_on(async {
/// #
/// use async_std::sync::channel;
Expand All @@ -466,6 +482,7 @@ impl<T> Receiver<T> {
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// use async_std::sync::channel;
///
/// let (_, r) = channel::<i32>(5);
Expand All @@ -480,6 +497,7 @@ impl<T> Receiver<T> {
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// # async_std::task::block_on(async {
/// #
/// use async_std::sync::channel;
Expand All @@ -501,6 +519,7 @@ impl<T> Receiver<T> {
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// # async_std::task::block_on(async {
/// #
/// use async_std::sync::channel;
Expand All @@ -522,6 +541,7 @@ impl<T> Receiver<T> {
/// # Examples
///
/// ```
/// #![allow(deprecated)]
/// # async_std::task::block_on(async {
/// #
/// use async_std::sync::channel;
Expand Down Expand Up @@ -993,6 +1013,7 @@ impl<T> Drop for Channel<T> {
#[cfg(feature = "unstable")]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
#[derive(PartialEq, Eq)]
#[deprecated = "new channel api at async_std::channel"]
pub enum TrySendError<T> {
/// The channel is full but not disconnected.
Full(T),
Expand Down Expand Up @@ -1025,6 +1046,7 @@ impl<T> Display for TrySendError<T> {
#[cfg(feature = "unstable")]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
#[derive(Debug, PartialEq, Eq)]
#[deprecated = "new channel api at async_std::channel"]
pub enum TryRecvError {
/// The channel is empty but not disconnected.
Empty,
Expand All @@ -1048,6 +1070,7 @@ impl Display for TryRecvError {
#[cfg(feature = "unstable")]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
#[derive(Debug, PartialEq, Eq)]
#[deprecated = "new channel api at async_std::channel"]
pub struct RecvError;

impl Error for RecvError {}
Expand Down
1 change: 1 addition & 0 deletions src/sync/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@ mod rwlock;

cfg_unstable! {
pub use barrier::{Barrier, BarrierWaitResult};
#[allow(deprecated)]
pub use channel::{channel, Sender, Receiver, RecvError, TryRecvError, TrySendError};
pub use condvar::Condvar;

Expand Down
1 change: 1 addition & 0 deletions tests/channel.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#![cfg(feature = "unstable")]
#![allow(deprecated)]

use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;
Expand Down
6 changes: 3 additions & 3 deletions tests/stream.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ use std::task::{Context, Poll};

use pin_project_lite::pin_project;

use async_std::channel::bounded as channel;
use async_std::prelude::*;
use async_std::stream;
use async_std::sync::channel;
use async_std::task;

#[cfg(target_arch = "wasm32")]
Expand Down Expand Up @@ -36,7 +36,7 @@ fn merging_delayed_streams_work() {

task::block_on(async move {
task::sleep(std::time::Duration::from_millis(500)).await;
sender.send(92).await;
sender.send(92).await.unwrap();
drop(sender);
let xs = t.await;
assert_eq!(xs, vec![92])
Expand All @@ -55,7 +55,7 @@ fn merging_delayed_streams_work() {

task::block_on(async move {
task::sleep(std::time::Duration::from_millis(500)).await;
sender.send(92).await;
sender.send(92).await.unwrap();
drop(sender);
let xs = t.await;
assert_eq!(xs, vec![92])
Expand Down