Improve doc for stream::raw::Status::remaining

gyscos · Oct 11, 2023 · ba0e851 · ba0e851
1 parent bd13b98
commit ba0e851
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/stream/raw.rs b/src/stream/raw.rs
@@ -118,7 +118,9 @@ impl Operation for NoOp {
 pub struct Status {
     /// Number of bytes expected for next input.
     ///
-    /// This is just a hint.
+    /// * If `remaining = 0`, then we are at the end of a frame.
+    /// * If `remaining > 0`, then it's just a hint for how much there is still
+    ///   to read.
     pub remaining: usize,
 
     /// Number of bytes read from the input.