rust/cfdp
6
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
High level CCSDS File Delivery Protocol (CFDP) components
8 Commits 3 Branches 0 Tags 1.5 MiB
Rust 98.9%
Python 0.6%
Dockerfile 0.5%
351e36ef79
Go to file
Robin Mueller 351e36ef79
Some checks failed
Rust/cfdp/pipeline/head There was a failure building this commit
Details
finished python code
2024-08-27 15:34:57 +02:00
.github/workflows init commit 2024-08-22 20:02:12 +02:00
automation init commit 2024-08-22 20:02:12 +02:00
examples/python-interop finished python code 2024-08-27 15:34:57 +02:00
src more dest handler tests 2024-08-26 18:15:43 +02:00
tests some more tests 2024-08-23 20:26:50 +02:00
.gitignore init commit 2024-08-22 20:02:12 +02:00
Cargo.toml init commit 2024-08-22 20:02:12 +02:00
CHANGELOG.md init commit 2024-08-22 20:02:12 +02:00
coverage.py init commit 2024-08-22 20:02:12 +02:00
LICENSE-APACHE init commit 2024-08-22 20:02:12 +02:00
NOTICE init commit 2024-08-22 20:02:12 +02:00
README.md init commit 2024-08-22 20:02:12 +02:00
release-checklist.md init commit 2024-08-22 20:02:12 +02:00

README.md

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

cfdp-rs supports various runtime environments and is also suitable for no_std environments. 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.