From 15456af48ab406d02ce8f5fb68276295985d5005 Mon Sep 17 00:00:00 2001 From: Alex Helfet Date: Fri, 22 Dec 2017 12:00:21 +0000 Subject: [PATCH] Normalise description text, move TODO entries to Github issues. --- Cargo.toml | 2 +- README.md | 2 +- src/lib.rs | 9 ++------- 3 files changed, 4 insertions(+), 9 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 5aa6a9c..45b80b1 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "framed" version = "0.1.0" -description = "Send and receive frames (arrays of bytes of varied size) over streams of bytes." +description = "Send and receive frames (arrays of bytes of varied length) over streams of bytes." authors = ["Alex Helfet "] categories = ["embedded", "encoding", "network-programming"] keywords = ["no_std", "networking", "datalink", "protocol", "embedded"] diff --git a/README.md b/README.md index 549dd46..d020431 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # `framed` -Rust crate to send and receive frames (arrays of bytes of varied size) +Rust crate to send and receive frames (arrays of bytes of varied length) over streams of bytes. See [rustdoc on docs.rs](https://docs.rs/crate/framed) diff --git a/src/lib.rs b/src/lib.rs index d95f73b..9ce5ff5 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,4 +1,5 @@ -//! Sending and receiving frames (slices of bytes of varied length). +//! Sending and receiving frames (arrays of bytes of varied length) +//! over streams of bytes. //! //! Conforming to / inspired by the [data link layer][dll] or layer 2 //! in the OSI networking model, this module enables sending slices of @@ -17,12 +18,6 @@ //! `trace`: Enable to print all data to stdout for testing. //! //! `use_std`: Use standard library, enabled by default; disable for no_std. -//! -//! ## TODO -//! * Start frame with a zero as well, then we detect partial frames. -//! * Add a length field to the beginning of the frame and a -//! checksum to the end. Perhaps make them optional. - #![deny(warnings)] #![feature(conservative_impl_trait)]