rust/cfdp
6
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
de8be20f36
cfdp/README.md
Robin Mueller de8be20f36
All checks were successful
Rust/cfdp/pipeline/head This commit looks good
Details
prepare first release
2024-09-11 10:23:33 +02:00

2.7 KiB
Raw Blame History

Crates.io docs.rs ci coverage

cfdp-rs - High level Rust crate for CFDP components

The cfdp-rs Rust crate offers some high-level CCSDS File Delivery Protocol (CFDP) components to perform file transfers according to the CCSDS Blue Book 727.0-B-5. The underlying base packet library used to generate the packets to be sent is the spacepackets library.

Features

The goal of this library is to be flexible enough to support the use-cases of both on-board software and of ground software. It has support to make integration on [std] systems as simple as possible, but also has sufficient abstraction to allow for integration onno_std environments. Currently, the handlers still require the [std] feature until thiserror supports error_in_core.

It is recommended to activate the alloc feature at the very least to allow using the primary components provided by this crate. These components will only allocate memory at initialization time and thus are still viable for systems where run-time allocation is prohibited.

Default features

  • std: Enables functionality relying on the standard library.
  • alloc: Enables features which require allocation support. Enabled by the std feature.

Optional Features

  • serde: Adds serde support for most types by adding Serialize and Deserialize derives
  • defmt: Add support for the defmt by adding the defmt::Format derive on many types.

Examples

You can check the documentation of individual modules for various usage examples.

Coverage

Coverage was generated using grcov. If you have not done so already, install the llvm-tools-preview:

rustup component add llvm-tools-preview
cargo install grcov --locked

After that, you can simply run coverage.py to test the project with coverage. You can optionally supply the --open flag to open the coverage report in your webbrowser.