Generic implementations for various CCSDS and ECSS packet standards in Rust
Go to file
Robin Müller b8be9ae641
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
Merge pull request 'Fixes for Miri' (#95) from fixes-for-miri into main
Reviewed-on: #95
2024-05-15 13:03:24 +02:00
.github/workflows add doctests to github CI 2024-05-02 14:48:31 +02:00
.idea/runConfigurations continue file data PDU 2023-05-30 15:36:02 +02:00
automation use cargo nextest in CI for testing 2024-04-04 13:13:43 +02:00
src it is now possible to run cargo miri 2024-05-14 15:34:40 +02:00
.gitignore CHANGELOG clarification, gitignore comments 2023-01-26 21:00:32 +01:00
Cargo.toml prepare next patch version 2024-04-20 10:42:36 +02:00
CHANGELOG.md remove defmt::Format impl for MetadataPduCreator 2024-05-14 15:01:26 +02:00
coverage.py that reduced coverage again.. 2023-12-06 01:12:33 +01:00
LICENSE-APACHE Init spacepackets crate 2022-06-18 22:48:51 +02:00
NOTICE update NOTICE file 2023-01-24 11:26:47 +01:00
README.md add miri chapter in README 2024-05-14 15:37:20 +02:00
release-checklist.md prepare next release candidate 2024-04-04 14:12:33 +02:00

Crates.io docs.rs ci coverage

ECSS and CCSDS Spacepackets

This package contains generic implementations for various CCSDS (Consultative Committee for Space Data Systems) and ECSS (European Cooperation for Space Standardization) packet standards.

Currently, this includes the following components:

Features

spacepackets supports various runtime environments and is also suitable for no_std environments.

Default features

  • std: Enables functionality relying on the standard library.
  • alloc: Enables features which operate on containers like alloc::vec::Vec. Enabled by the std feature.

Optional Features

  • serde: Adds serde support for most types by adding Serialize and Deserialize derives
  • chrono: Add basic support for the chrono time library.
  • timelib: Add basic support for the time time library.
  • 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.

Miri

You can run the miri tool on this library to check for undefined behaviour (UB). This library does not use use any unsafe code blocks, but miri could still catch UB from used libraries.

cargo +nightly miri nextest run --all-features