Added basic docs to `Source`.

Fortune for chacha20stream's current commit: Middle blessing − 中吉
3 years ago · 1feb9b209b
parent ea70fdc2d1
commit 1feb9b209b
1 changed files with 4 additions and 1 deletions
--- 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>
 {