ank/framed-rs
1
Fork 0
Code Issues Activity
fork of https://github.com/fluffysquirrels/framed-rs with patches from https://github.com/talynAir/framed-rs/ and https://github.com/andber1/framed-rs
136 commits 1 branch 0 tags 186 KiB
Rust 90.5%
Shell 9.5%
Find a file
Andy Killorin c76d988fad
updated cobs and acknowledged const_fn stability
2025-01-27 23:10:07 -05:00
bin build_tc denies warnings for CI builds. 2020-11-21 19:28:43 +00:00
decode Permit warnings. 2020-11-21 19:12:03 +00:00
doc Add tag command to doc/release.md 2019-04-13 17:01:58 +01:00
framed updated cobs and acknowledged const_fn stability 2025-01-27 23:10:07 -05:00
test_type Permit warnings. 2020-11-21 19:12:03 +00:00
.gitignore WIP on decode tool. 2017-12-27 13:35:00 +00:00
.travis.yml Travis target Ubuntu Bionic. 2020-02-03 00:59:58 +00:00
Cargo.lock updated cobs and acknowledged const_fn stability 2025-01-27 23:10:07 -05: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

README.md

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.