aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/stream.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/stream.rs b/src/stream.rs
index b887b18d..bbf7a91d 100644
--- a/src/stream.rs
+++ b/src/stream.rs
@@ -219,6 +219,10 @@ pub fn is_bidi(id: u64) -> bool {
}
/// An iterator over the streams that have outstanding data to read.
+///
+/// This can be obtained by calling a connection's [`readable()`] method.
+///
+/// [`readable()`]: struct.Connection.html#method.readable
pub struct Readable<'a> {
streams: hash_map::Iter<'a, u64, Stream>,
}