aboutsummaryrefslogtreecommitdiff
path: root/src/reader.rs
diff options
context:
space:
mode:
authorMartin Fischer <martin@push-f.com>2023-08-12 11:50:46 +0200
committerMartin Fischer <martin@push-f.com>2023-08-19 06:41:55 +0200
commit69fdbee250ebfce135bff2671226097bc536d953 (patch)
tree994ef511feb77d7a095dc43ec62bca681242228e /src/reader.rs
parent7a42549d3121bb9fe29e7e58260a287e62714bc3 (diff)
break!: stop re-exporting reader traits & types
This is primarily done to make the rustdoc more readable (by grouping Reader, IntoReader, StringReader and BufReadReader in the reader module). Ideally IntoReader is already implemented for your input type and you don't have to concern yourself with these traits / types at all.
Diffstat (limited to 'src/reader.rs')
-rw-r--r--src/reader.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/reader.rs b/src/reader.rs
index fa83139..e0161e5 100644
--- a/src/reader.rs
+++ b/src/reader.rs
@@ -1,3 +1,5 @@
+//! Provides the [`Reader`] trait (and implementations) used by the tokenizer.
+
use std::convert::Infallible;
use std::io::{self, BufRead, BufReader, Read};