ank/framed-rs
1
Fork 0
Code Issues Activity

Normalise description text, move TODO entries to Github issues.

Browse source
This commit is contained in:
Alex Helfet 2017-12-22 12:00:21 +00:00
parent 48b5107d56
commit 15456af48a
3 changed files with 4 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Cargo.toml
View file

@ -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 <alex.helfet@gmail.com>"]
categories = ["embedded", "encoding", "network-programming"]
keywords = ["no_std", "networking", "datalink", "protocol", "embedded"]

2
README.md
View file

@ -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)

9
src/lib.rs
View file

@ -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)]