ank/framed-rs
1
Fork 0
Code Issues Activity

Doc comment for FRAME_END_SYMBOL.

Browse source
This commit is contained in:
Alex Helfet 2017-12-28 16:45:47 +00:00
parent 8ab6758169
commit 42b75a7551
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
framed/src/lib.rs
View file

@ -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; pub const FRAME_END_SYMBOL: u8 = 0;
const HEADER_LEN: usize = 0; const HEADER_LEN: usize = 0;