ank/framed-rs
1
Fork 0
Code Issues Activity

Docs.

Browse source
This commit is contained in:
Alex Helfet 2017-12-22 12:49:56 +00:00
parent 872e6e3ceb
commit 1fb8c16cc3
1 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
src/lib.rs
View file

@ -10,10 +10,20 @@
//! [dll]: https://en.wikipedia.org/wiki/Data_link_layer
//! [pl]: https://en.wikipedia.org/wiki/Physical_layer
//!
//! Currently the encoding is: the frame [COBS]-encoded
//! to remove bytes equal to zero, then a terminating zero byte.
//! ## Encoding
//!
//! Currently the encoding is:
//! * The frame [COBS]-encoded to remove bytes equal to zero
//! * A terminating zero byte.
//! [COBS]: https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing
//!
//! The encoding is not stable at the moment, i.e. it can and will
//! change between minor versions. Consequently encoded data from this
//! crate is unsuitable for long-term storage or transmission between
//! different versions of an application. The API should be kept
//! stable between versions where possible and the crate version will
//! follow Rust semver rules on API changes.
//!
//! ## Cargo feature flags
//! `trace`: Enable to print all data to stdout for testing.
//!
@ -72,14 +82,8 @@ impl<W: Write> Sender<W> {
}
/// Receives frames from an underlying `io::Read` instance.
///
/// TODO: Add a recv() variant suitable for no_std use, e.g. one that
/// takes a `&mut [u8]`.
#[cfg(feature = "use_std")]
pub struct Receiver<R: Read> {
#[cfg_attr(not(feature = "use_std"), allow(dead_code))]
/// The underlying reader
r: R,
}