1
Fork 0
Find a file
2019-04-13 14:19:17 +01:00
bin build scripts run a xargo build with a no_std target. 2018-03-17 16:26:18 +00:00
decode Update cobs (new streaming interface), and clap (fix decode build). 2019-04-13 13:48:06 +01:00
doc Update version to 0.3.0 2017-12-30 18:17:20 +00:00
framed More logging in tests. 2019-04-13 14:19:17 +01:00
test_type Improved ergonomics of config builder, more tests. 2017-12-31 15:47:19 +00:00
.gitignore WIP on decode tool. 2017-12-27 13:35:00 +00:00
.travis.yml build scripts run a xargo build with a no_std target. 2018-03-17 16:26:18 +00:00
Cargo.lock Update cobs (new streaming interface), and clap (fix decode build). 2019-04-13 13:48:06 +01:00
Cargo.toml WIP on decode tool. 2017-12-27 13:35:00 +00:00
LICENSE-APACHE Created crate, interface and failing test. 2017-12-21 02:29:43 +00:00
LICENSE-MIT Created crate, interface and failing test. 2017-12-21 02:29:43 +00:00
README.md Update README.md 2017-12-31 18:23:49 +00:00

framed

Rust crate to send and receive data over lossy streams of bytes.

  • Supports sending slices of bytes or serde-serialized types.
  • Uses a checksum to detect and skip corrupted frames.
  • Includes a command-line tool to decode and display serialized types.

Crate

Documentation: Documentation

This crate should build on the latest Rust stable, beta, and nightly toolchains. When the cargo feature use_std is disabled (requires nightly toolchain), it should also build in embedded projects with no_std.

Development

Source code and issues on GitHub: GitHub last commit

CI build on Travis CI: Build Status

Pull requests welcome.

Sub-crates

  • framed in directory ./framed:

    The core library.

  • framed_decode in directory ./decode:

    A command line tool to decode data encoded by the library. See ./decode/README.md for its documentation.

  • framed_test_type in directory ./test_type:

    A crate for testing framed: a library with encodable types and a binary that outputs encoded data.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.