From 20199e36103f3c87b9ed6a0f05bb678950525d82 Mon Sep 17 00:00:00 2001
From: Avril <flanchan@cumallover.me>
Date: Fri, 13 Aug 2021 16:12:54 +0100
Subject: [PATCH] Added basic docs to `Source`.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Fortune for chacha20stream's current commit: Middle blessing − 中吉
---
 src/stream/mod.rs    | 2 ++
 src/stream/source.rs | 5 ++++-
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/stream/mod.rs b/src/stream/mod.rs
index c6eee3d..46731bd 100644
--- a/src/stream/mod.rs
+++ b/src/stream/mod.rs
@@ -27,6 +27,8 @@ pub mod source;
 pub use sink::Sink;
 pub use source::Source;
 
+//TODO: Stream: Wrapper over both Sink and Source?
+
 #[cfg(test)]
 mod tests
 {
diff --git a/src/stream/source.rs b/src/stream/source.rs
index 384418f..583ca23 100644
--- a/src/stream/source.rs
+++ b/src/stream/source.rs
@@ -105,7 +105,10 @@ pub type DefaultBuffer = UseBufferInternal;
 #[cfg(feature="ad-hoc-buffer")] 
 pub type DefaultBuffer = UseBufferExternal;
 
-/// TODO: Document
+/// ChaCha source.
+/// En/decrypts information from the source reader.
+///
+/// This is the `Read` implementing counterpart to `Sink`.
 //#[derive(Debug)]
 pub struct Source<R: ?Sized, Buffer: ?Sized + BufferKind = DefaultBuffer>
 {