Document 'async fn' notation for boardcast::Receiver::recv

This commit is contained in:
Jonas Platte 2024-10-25 00:55:07 +02:00
parent 8bc21be4d3
commit ba5f590acd
No known key found for this signature in database
GPG Key ID: 7D261D771D915378

View File

@ -1215,6 +1215,12 @@ impl<T: Clone> Receiver<T> {
}
/// Receives the next value for this receiver.
///
/// Equivalent to:
///
/// ```ignore
/// async fn recv(&self) -> Result<T, RecvError>;
/// ```
///
/// Each [`Receiver`] handle will receive a clone of all values sent
/// **after** it has subscribed.
///