aboutsummaryrefslogtreecommitdiff
path: root/src/buf/buf.rs
diff options
context:
space:
mode:
authorGravatar Carl Lerche <me@carllerche.com> 2017-03-16 12:11:10 -0700
committerGravatar GitHub <noreply@github.com> 2017-03-16 12:11:10 -0700
commit99fba239db1962e8c039d3255e4e5417aef283ba (patch)
treed0794a4db5df1ffc8f77b857ebc0052f1513e81d /src/buf/buf.rs
parentdcd6c184e43ca1617114cfb76b4b29d01626e4f4 (diff)
downloadbytes-99fba239db1962e8c039d3255e4e5417aef283ba.tar.gz
bytes-99fba239db1962e8c039d3255e4e5417aef283ba.tar.zst
bytes-99fba239db1962e8c039d3255e4e5417aef283ba.zip
Tweak docs (#76)
Diffstat (limited to 'src/buf/buf.rs')
-rw-r--r--src/buf/buf.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/buf/buf.rs b/src/buf/buf.rs
index 7b26904..42280e7 100644
--- a/src/buf/buf.rs
+++ b/src/buf/buf.rs
@@ -9,7 +9,8 @@ use std::{cmp, io, ptr};
/// A buffer stores bytes in memory such that read operations are infallible.
/// The underlying storage may or may not be in contiguous memory. A `Buf` value
/// is a cursor into the buffer. Reading from `Buf` advances the cursor
-/// position.
+/// position. It can be thought of as an efficient `Iterator` for collections of
+/// bytes.
///
/// The simplest `Buf` is a `Cursor` wrapping a `[u8]`.
///