https://github.com/fluffysquirrels/framed-rs

Rust crate to send and receive slices of bytes over lossy streams of bytes.
https://github.com/fluffysquirrels/framed-rs

embedded networking no-std rust

Last synced: 8 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/fluffysquirrels/framed-rs
• Owner: fluffysquirrels
• License: apache-2.0
• Created: 2017-12-21T02:00:58.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-08-13T19:22:35.000Z (3 months ago)
• Last Synced: 2024-10-19T14:01:48.932Z (17 days ago)
• Topics: embedded, networking, no-std, rust
• Language: Rust
• Homepage:
• Size: 117 KB
• Stars: 7
• Watchers: 2
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# `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](https://img.shields.io/crates/v/framed.svg)](https://crates.io/crates/framed)

Documentation:

[![Documentation](https://docs.rs/framed/badge.svg)](https://docs.rs/framed)

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](https://img.shields.io/github/last-commit/fluffysquirrels/framed-rs.svg)][github]

   [github]: https://github.com/fluffysquirrels/framed-rs

CI build on Travis CI: [![Build Status](https://travis-ci.org/fluffysquirrels/framed-rs.svg)](https://travis-ci.org/fluffysquirrels/framed-rs)

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

- Apache License, Version 2.0 (see LICENSE-APACHE or

  )

- MIT license (see LICENSE-MIT or )

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.