summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Fischer <martin@push-f.com>2023-09-03 13:36:14 +0200
committerMartin Fischer <martin@push-f.com>2023-09-03 23:00:05 +0200
commit890380c018c2396d1242e957b9d7db126f31488c (patch)
tree7a8e5fbf8573f600bd86fdafb6519e6ce0b4159d
parent6a020bcc6b60ce754142e6a38c1f25aaf889ebcb (diff)
docs: document that BufReadReader reads UTF-8
-rw-r--r--src/reader.rs3
1 files changed, 1 insertions, 2 deletions
diff --git a/src/reader.rs b/src/reader.rs
index b6e0905..b08821f 100644
--- a/src/reader.rs
+++ b/src/reader.rs
@@ -112,8 +112,7 @@ impl<'a> IntoReader<'a> for &'a String {
}
}
-/// A [`BufReadReader`] can be used to construct a tokenizer from any type that implements
-/// `BufRead`.
+/// A [`BufRead`]-based [`Reader`] implementation that attempts to read UTF-8.
pub struct BufReadReader<R: BufRead> {
line: String,
line_pos: usize,