diff --git a/framed/src/lib.rs b/framed/src/lib.rs index 444e59f..13f7657 100644 --- a/framed/src/lib.rs +++ b/framed/src/lib.rs @@ -342,7 +342,7 @@ const HEADER_LEN: usize = 0; const FOOTER_LEN: usize = 1; /// Encode the supplied payload data as a frame at the beginning of -/// the supplied buffer `dest`. +/// the supplied buffer `dest`. Available from `no_std` crates. /// /// Returns the number of bytes it has written to the buffer. /// @@ -388,7 +388,7 @@ pub fn encode_to_writer(p: &Payload, w: &mut W) -> Result { } /// Decode the supplied encoded frame, placing the payload at the -/// beginning of the supplied buffer `dest`. +/// beginning of the supplied buffer `dest`. Available from `no_std` crates. /// /// When reading from a stream, the caller can continue reading data /// and buffering it until a `FRAME_END_SYMBOL` is read, then pass the diff --git a/framed/src/typed.rs b/framed/src/typed.rs index 7750593..32f51d6 100644 --- a/framed/src/typed.rs +++ b/framed/src/typed.rs @@ -104,6 +104,7 @@ use std::io::{Read, Write}; /// Serializes and encodes the supplied value `v` into destination /// buffer `dest`, using `ser_buf` as a temporary serialization buffer. +/// Available from `no_std` crates. /// /// Returns the number of bytes written to the beginning of `dest`. /// @@ -134,7 +135,7 @@ pub fn encode_to_slice( /// Decodes the supplied encoded frame `e`, then deserializes its /// payload as a value of type `T`, using `de_buf` as a temporary -/// deserialization buffer. +/// deserialization buffer. Available from `no_std` crates. /// /// Returns the deserialized value. ///