aboutsummaryrefslogtreecommitdiff
path: root/src/buf/buf.rs
diff options
context:
space:
mode:
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 ad3f812..3b4096f 100644
--- a/src/buf/buf.rs
+++ b/src/buf/buf.rs
@@ -91,7 +91,8 @@ pub trait Buf {
fn remaining(&self) -> usize;
/// Returns a slice starting at the current position and of length between 0
- /// and `Buf::remaining()`.
+ /// and `Buf::remaining()`. Note that this *can* return shorter slice (this allows
+ /// non-continuous internal representation).
///
/// This is a lower level function. Most operations are done with other
/// functions.