From 31f129ebe7a8f3c43b596f848934c586c7a131e8 Mon Sep 17 00:00:00 2001 From: Yoshua Wuyts Date: Thu, 14 Nov 2019 22:37:04 +0100 Subject: [PATCH] backlink channel types Signed-off-by: Yoshua Wuyts --- src/sync/channel.rs | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/sync/channel.rs b/src/sync/channel.rs index 392c851..2647f65 100644 --- a/src/sync/channel.rs +++ b/src/sync/channel.rs @@ -71,6 +71,11 @@ pub fn channel(cap: usize) -> (Sender, Receiver) { /// The sending side of a channel. /// +/// This struct is created by the [`channel`] function. See its +/// documentation for more. +/// +/// [`channel`]: fn.channel.html +/// /// # Examples /// /// ``` @@ -298,8 +303,11 @@ impl fmt::Debug for Sender { /// The receiving side of a channel. /// -/// This type implements the [`Stream`] trait, which means it can act as an asynchronous iterator. +/// This type receives messages by calling `recv`. But it also implements the [`Stream`] trait, +/// which means it can act as an asynchronous iterator. This struct is created by the [`channel`] +/// function. See its documentation for more. /// +/// [`channel`]: fn.channel.html /// [`Stream`]: ../stream/trait.Stream.html /// /// # Examples