diff --git a/framed/src/lib.rs b/framed/src/lib.rs index eae45de..1a34b42 100644 --- a/framed/src/lib.rs +++ b/framed/src/lib.rs @@ -173,6 +173,11 @@ impl Deref for BoxEncoded { } } +/// The frame ends with (and includes) this byte. +/// +/// Consumers can read encoded data into a buffer until they encounter +/// this value and then use one of the `decode_*` functions to decode +/// the frame's payload. pub const FRAME_END_SYMBOL: u8 = 0; const HEADER_LEN: usize = 0;