mirror/async-std
2
0
Fork 1
mirror of https://github.com/async-rs/async-std.git synced 2025-02-06 12:45:32 +00:00
Code Issues Releases Wiki Activity

Merge pull request #984 from cagatay-y/master

Browse source 
doc: update docs to fit the move of channels from the sync module
This commit is contained in:
Yoshua Wuyts 2021-08-31 16:22:35 +02:00 committed by GitHub
commit a2f5859862
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/channel.rs
View file

@ -1,4 +1,8 @@
//! Channels
//!
//! Multi-producer, multi-consumer queues, used for message-based
//! communication. Can provide a lightweight inter-task synchronisation
//! mechanism, at the cost of some extra memory.
#[doc(inline)]
pub use async_channel::*;

8
src/sync/mod.rs
View file

@ -129,11 +129,6 @@
//! to reach a point in the program, before continuing execution all
//! together.
//!
//! - [`channel`]: Multi-producer, multi-consumer queues, used for
//! message-based communication. Can provide a lightweight
//! inter-task synchronisation mechanism, at the cost of some
//! extra memory.
//!
//! - [`Mutex`]: Mutual exclusion mechanism, which ensures that at
//! most one task at a time is able to access some data.
//!
@ -142,6 +137,9 @@
//! writer at a time. In some cases, this can be more efficient than
//! a mutex.
//!
//! If you're looking for channels, check out
//! [`async_std::channel`][crate::channel].
//!
//! [`Arc`]: struct.Arc.html
//! [`Barrier`]: struct.Barrier.html
//! [`channel`]: fn.channel.html