From e1346fe85b75e64e5c975d183c7eba54f9ded294 Mon Sep 17 00:00:00 2001 From: Alex Helfet Date: Mon, 25 Dec 2017 02:53:38 +0000 Subject: [PATCH] Update docs on typed module. --- Cargo.toml | 2 +- README.md | 2 +- src/lib.rs | 2 +- src/typed.rs | 11 ++++++++++- 4 files changed, 13 insertions(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index cf068f7..de76665 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "framed" version = "0.1.3" -description = "Send and receive slices of bytes over lossy streams of bytes." +description = "Send and receive data over lossy streams of bytes." authors = ["Alex Helfet "] categories = ["no-std", "embedded", "encoding", "network-programming"] keywords = ["no_std", "networking", "datalink", "protocol", "embedded"] diff --git a/README.md b/README.md index 64aa4fc..ae98d70 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # `framed` -Rust crate to send and receive slices of bytes over lossy streams of bytes. +Rust crate to send and receive data over lossy streams of bytes. [![Crate](https://img.shields.io/crates/v/framed.svg)](https://crates.io/crates/framed) diff --git a/src/lib.rs b/src/lib.rs index e834664..d302c9b 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,4 +1,4 @@ -//! Send and receive slices of bytes over lossy streams of bytes. +//! Send and receive data over lossy streams of bytes. //! //! Living in / inspired by the [data link layer][dll] or layer 2 //! in the OSI networking model, this module enables sending slices of diff --git a/src/typed.rs b/src/typed.rs index 063b5ba..f9aeb86 100644 --- a/src/typed.rs +++ b/src/typed.rs @@ -1,4 +1,13 @@ -//! Sending and receiving structs serialized with serde. +//! Sending and receiving structs serialized with serde and +//! [`ssmarshal`][ssmarshal]. +//! +//! [ssmarshal]: https://crates.io/crates/ssmarshal +//! +//! `ssmarshal` uses a straightforward, compact serialization format +//! that doesn't support compatibility between versions or dynamic +//! length types (arrays, maps). Its lack of stability fits with the +//! frame encoding in this crate: unsuitable for long-term storage or +//! transmission between different versions of an application. //! //! This module currently requires `std`, the standard library.