Update docs on typed module.
This commit is contained in:
parent
d0bf721c9e
commit
e1346fe85b
4 changed files with 13 additions and 4 deletions
|
@ -1,7 +1,7 @@
|
||||||
[package]
|
[package]
|
||||||
name = "framed"
|
name = "framed"
|
||||||
version = "0.1.3"
|
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 <alex.helfet@gmail.com>"]
|
authors = ["Alex Helfet <alex.helfet@gmail.com>"]
|
||||||
categories = ["no-std", "embedded", "encoding", "network-programming"]
|
categories = ["no-std", "embedded", "encoding", "network-programming"]
|
||||||
keywords = ["no_std", "networking", "datalink", "protocol", "embedded"]
|
keywords = ["no_std", "networking", "datalink", "protocol", "embedded"]
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# `framed`
|
# `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.
|
||||||
|
|
||||||
[](https://crates.io/crates/framed)
|
[](https://crates.io/crates/framed)
|
||||||
|
|
||||||
|
|
|
@ -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
|
//! Living in / inspired by the [data link layer][dll] or layer 2
|
||||||
//! in the OSI networking model, this module enables sending slices of
|
//! in the OSI networking model, this module enables sending slices of
|
||||||
|
|
11
src/typed.rs
11
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.
|
//! This module currently requires `std`, the standard library.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue