summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNora Widdecke <nora@sequoia-pgp.org>2020-11-05 17:28:29 +0100
committerNora Widdecke <nora@sequoia-pgp.org>2020-11-09 14:18:56 +0100
commitee149e41039d835599701a386aa85571d23ee543 (patch)
treef7ea37f84a0c9e415153b8446de083f16f9c92d0
parent9e112763cc1c3b042b17376b6881812723331806 (diff)
buffered_reader: Explain fmt::Display use.
-rw-r--r--buffered-reader/src/lib.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/buffered-reader/src/lib.rs b/buffered-reader/src/lib.rs
index 308187ea..83f6da1c 100644
--- a/buffered-reader/src/lib.rs
+++ b/buffered-reader/src/lib.rs
@@ -816,8 +816,9 @@ pub trait BufferedReader<C> : io::Read + fmt::Debug + fmt::Display
Ok(at_least_one_byte)
}
- /// Dump
/// A helpful debugging aid to pretty print a Buffered Reader stack.
+ ///
+ /// Uses the Buffered Readers' `fmt::Display` implementations.
fn dump(&self) where Self: std::marker::Sized {
let mut i = 1;
let mut reader: Option<&dyn BufferedReader<C>> = Some(self);