Added basic docs to `Source`.

Fortune for chacha20stream's current commit: Middle blessing − 中吉
read-stream-wrapper-async
Avril 3 years ago
parent ea70fdc2d1
commit 20199e3610

@ -27,6 +27,8 @@ pub mod source;
pub use sink::Sink; pub use sink::Sink;
pub use source::Source; pub use source::Source;
//TODO: Stream: Wrapper over both Sink and Source?
#[cfg(test)] #[cfg(test)]
mod tests mod tests
{ {

@ -105,7 +105,10 @@ pub type DefaultBuffer = UseBufferInternal;
#[cfg(feature="ad-hoc-buffer")] #[cfg(feature="ad-hoc-buffer")]
pub type DefaultBuffer = UseBufferExternal; 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)] //#[derive(Debug)]
pub struct Source<R: ?Sized, Buffer: ?Sized + BufferKind = DefaultBuffer> pub struct Source<R: ?Sized, Buffer: ?Sized + BufferKind = DefaultBuffer>
{ {

Loading…
Cancel
Save