Merge pull request 'prepare next release candidate' (#78) from prep_v0.11.0-rc.1 into main

Reviewed-on: #78

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 # [unreleased]
 
+# [v0.11.0-rc.1] 2024-04-03
+
 Major API changes for the time API. If you are using the time API, it is strongly recommended
 to check all the API changes in the **Changed** chapter.
 
@@ -24,9 +26,14 @@ to check all the API changes in the **Changed** chapter.
 - Added basic support conversions to the `time` library. Introduce new `chrono` and `timelib`
   feature gate.
 - Added `CcsdsTimeProvider::timelib_date_time`.
+- Optional support for `defmt` by adding optional `defmt::Format` derives for common types.
 
 ## Changed
 
+- `PusTcCreator::new_simple` now expects a valid slice for the source data instead of an optional
+  slice. For telecommands without application data, `&[]` can be passed.
+- `PusTmSecondaryHeader` constructors now expects a valid slice for the time stamp instead of an
+  optional slice.
 - Renamed `CcsdsTimeProvider::date_time` to `CcsdsTimeProvider::chrono_date_time`
 - Renamed `CcsdsTimeCodes` to `CcsdsTimeCode`
 - Renamed `cds::TimeProvider` to `cds::CdsTime`

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "spacepackets"
-version = "0.11.0-rc.0"
+version = "0.11.0-rc.1"
 edition = "2021"
 rust-version = "1.61"
 authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
@@ -48,6 +48,10 @@ optional = true
 version = "0.2"
 default-features = false
 
+[dependencies.defmt]
+version = "0.3"
+optional = true
+
 [dev-dependencies]
 postcard = "1"
 chrono = "0.4"
@@ -59,7 +63,8 @@ serde = ["dep:serde", "chrono/serde"]
 alloc = ["postcard/alloc", "chrono/alloc"]
 chrono = ["dep:chrono"]
 timelib = ["dep:time"]
+defmt = ["dep:defmt"]
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
+rustdoc-args = ["--cfg", "docs_rs", "--generate-link-to-definition"]

README.md

@@ -45,6 +45,8 @@ deserializing them with an appropriate `serde` provider like
  - [`serde`](https://serde.rs/): Adds `serde` support for most types by adding `Serialize` and `Deserialize` `derive`s
  - [`chrono`](https://crates.io/crates/chrono): Add basic support for the `chrono` time library.
  - [`timelib`](https://crates.io/crates/time): Add basic support for the `time` time library.
+ - [`defmt`](https://defmt.ferrous-systems.com/): Add support for the `defmt` by adding the
+   [`defmt::Format`](https://defmt.ferrous-systems.com/format) derive on many types.
 
 # Examples
 

release-checklist.md

@@ -4,11 +4,11 @@ Checklist for new releases
 # Pre-Release
 
 1. Make sure any new modules are documented sufficiently enough and check docs with
-   `cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docsrs"]' --open`.
+   `cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docs_rs"]' --open`.
 2. Bump version specifier in `Cargo.toml`.
 3. Update `CHANGELOG.md`: Convert `unreleased` section into version section with date and add new
    `unreleased` section.
-4. Run `cargo test --all-features`.
+4. Run `cargo test --all-features` or `cargo nextest r --all-features`.
 5. Run `cargo fmt` and `cargo clippy`. Check `cargo msrv` against MSRV in `Cargo.toml`.
 6. Wait for CI/CD results for EGit and Github. These also check cross-compilation for bare-metal
    targets.

src/cfdp/lv.rs

@@ -20,6 +20,7 @@ pub const MIN_LV_LEN: usize = 1;
 ///    this will be the lifetime of that data reference.
 #[derive(Debug, Copy, Clone, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct Lv<'data> {
     data: &'data [u8],
     // If the LV was generated from a raw bytestream, this will contain the start of the

src/cfdp/mod.rs

@@ -18,6 +18,7 @@ pub const CFDP_VERSION_2: u8 = 0b001;
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum PduType {
     FileDirective = 0,
@@ -26,6 +27,7 @@ pub enum PduType {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum Direction {
     TowardsReceiver = 0,
@@ -34,6 +36,7 @@ pub enum Direction {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum TransmissionMode {
     Acknowledged = 0,
@@ -42,6 +45,7 @@ pub enum TransmissionMode {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum CrcFlag {
     NoCrc = 0,
@@ -69,6 +73,7 @@ impl From<CrcFlag> for bool {
 /// Always 0 and ignored for File Directive PDUs (CCSDS 727.0-B-5 P.75)
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum SegmentMetadataFlag {
     NotPresent = 0,
@@ -78,6 +83,7 @@ pub enum SegmentMetadataFlag {
 /// Always 0 and ignored for File Directive PDUs (CCSDS 727.0-B-5 P.75)
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum SegmentationControl {
     NoRecordBoundaryPreservation = 0,
@@ -86,6 +92,7 @@ pub enum SegmentationControl {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum FaultHandlerCode {
     NoticeOfCancellation = 0b0001,
@@ -96,6 +103,7 @@ pub enum FaultHandlerCode {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum ConditionCode {
     /// This is not an error condition for which a faulty handler override can be specified
@@ -118,6 +126,7 @@ pub enum ConditionCode {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum LargeFileFlag {
     /// 32 bit maximum file size and FSS size
@@ -129,6 +138,7 @@ pub enum LargeFileFlag {
 /// Transaction status for the ACK PDU field according to chapter 5.2.4 of the CFDP standard.
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum TransactionStatus {
     /// Transaction is not currently active and the CFDP implementation does not retain a
@@ -146,6 +156,7 @@ pub enum TransactionStatus {
 /// [SANA Checksum Types registry](https://sanaregistry.org/r/checksum_identifiers/)
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum ChecksumType {
     /// Modular legacy checksum
@@ -167,6 +178,7 @@ pub const NULL_CHECKSUM_U32: [u8; 4] = [0; 4];
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum TlvLvError {
     DataTooLarge(usize),
     ByteConversion(ByteConversionError),

src/cfdp/pdu/ack.rs

@@ -15,6 +15,7 @@ use serde::{Deserialize, Serialize};
 /// For more information, refer to CFDP chapter 5.2.4.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct AckPdu {
     pdu_header: PduHeader,
     directive_code_of_acked_pdu: FileDirectiveType,

src/cfdp/pdu/eof.rs

@@ -15,6 +15,7 @@ use super::{CfdpPdu, WritablePduPacket};
 /// For more information, refer to CFDP chapter 5.2.2.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct EofPdu {
     pdu_header: PduHeader,
     condition_code: ConditionCode,

src/cfdp/pdu/finished.rs

@@ -14,6 +14,7 @@ use super::{CfdpPdu, WritablePduPacket};
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum DeliveryCode {
     Complete = 0,
@@ -22,6 +23,7 @@ pub enum DeliveryCode {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum FileStatus {
     DiscardDeliberately = 0b00,
@@ -34,6 +36,7 @@ pub enum FileStatus {
 ///
 /// For more information, refer to CFDP chapter 5.2.3.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct FinishedPduCreator<'fs_responses> {
     pdu_header: PduHeader,
     condition_code: ConditionCode,
@@ -219,6 +222,7 @@ impl<'buf> Iterator for FilestoreResponseIterator<'buf> {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct FinishedPduReader<'buf> {
     pdu_header: PduHeader,
     condition_code: ConditionCode,

src/cfdp/pdu/metadata.rs

@@ -15,6 +15,7 @@ use super::{CfdpPdu, WritablePduPacket};
 
 #[derive(Default, Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct MetadataGenericParams {
     pub closure_requested: bool,
     pub checksum_type: ChecksumType,
@@ -55,6 +56,7 @@ pub fn build_metadata_opts_from_vec(
 /// This abstraction exposes a specialized API for creating metadata PDUs as specified in
 /// CFDP chapter 5.2.5.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct MetadataPduCreator<'src_name, 'dest_name, 'opts> {
     pdu_header: PduHeader,
     metadata_params: MetadataGenericParams,
@@ -241,6 +243,7 @@ impl<'opts> Iterator for OptionsIter<'opts> {
 /// involved.
 #[derive(Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct MetadataPduReader<'buf> {
     pdu_header: PduHeader,
     metadata_params: MetadataGenericParams,

src/cfdp/pdu/mod.rs

@@ -18,6 +18,7 @@ pub mod nak;
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum FileDirectiveType {
     EofPdu = 0x04,
@@ -220,6 +221,7 @@ pub trait CfdpPdu {
 /// same.
 #[derive(Debug, Copy, Clone, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct CommonPduConfig {
     source_entity_id: UnsignedByteField,
     dest_entity_id: UnsignedByteField,
@@ -358,6 +360,7 @@ pub const FIXED_HEADER_LEN: usize = 4;
 /// For detailed information, refer to chapter 5.1 of the CFDP standard.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PduHeader {
     pdu_type: PduType,
     pdu_conf: CommonPduConfig,

src/cfdp/pdu/nak.rs

@@ -12,6 +12,7 @@ use super::{
 /// Helper type to encapsulate both normal file size segment requests and large file size segment
 /// requests.
 #[derive(Debug, PartialEq, Eq, Clone)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum SegmentRequests<'a> {
     U32Pairs(&'a [(u32, u32)]),
     U64Pairs(&'a [(u64, u64)]),
@@ -31,6 +32,7 @@ impl SegmentRequests<'_> {
 /// It exposes a specialized API which simplifies to generate these NAK PDUs with the
 /// format according to CFDP chapter 5.2.6.
 #[derive(Debug, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct NakPduCreator<'seg_reqs> {
     pdu_header: PduHeader,
     start_of_scope: u64,
@@ -353,6 +355,7 @@ impl<T: SegReqFromBytes> SegmentRequestIter<'_, T> {
 ///
 /// The NAK format is expected to be conforming to CFDP chapter 5.2.6.
 #[derive(Debug, PartialEq, Eq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct NakPduReader<'seg_reqs> {
     pdu_header: PduHeader,
     start_of_scope: u64,

src/cfdp/tlv/mod.rs

@@ -52,6 +52,7 @@ pub trait WritableTlv {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum TlvType {
     FilestoreRequest = 0x00,
@@ -64,6 +65,7 @@ pub enum TlvType {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum TlvTypeField {
     Standard(TlvType),
     Custom(u8),
@@ -71,6 +73,7 @@ pub enum TlvTypeField {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum FilestoreActionCode {
     CreateFile = 0b0000,
@@ -118,6 +121,7 @@ impl From<TlvTypeField> for u8 {
 ///    this will be the lifetime of that data reference.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct Tlv<'data> {
     tlv_type_field: TlvTypeField,
     #[cfg_attr(feature = "serde", serde(borrow))]
@@ -224,6 +228,7 @@ pub(crate) fn verify_tlv_type(raw_type: u8, expected_tlv_type: TlvType) -> Resul
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct EntityIdTlv {
     entity_id: UnsignedByteField,
 }
@@ -348,6 +353,7 @@ pub fn fs_request_has_second_filename(action_code: FilestoreActionCode) -> bool
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 struct FilestoreTlvBase<'first_name, 'second_name> {
     pub action_code: FilestoreActionCode,
     #[cfg_attr(feature = "serde", serde(borrow))]
@@ -561,6 +567,7 @@ impl GenericTlv for FilestoreRequestTlv<'_, '_> {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct FilestoreResponseTlv<'first_name, 'second_name, 'fs_msg> {
     #[cfg_attr(feature = "serde", serde(borrow))]
     base: FilestoreTlvBase<'first_name, 'second_name>,

src/ecss/hk.rs

@@ -5,6 +5,7 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum Subservice {
     // Regular HK

src/ecss/mod.rs

@@ -74,6 +74,7 @@ pub enum PusServiceId {
 /// All PUS versions. Only PUS C is supported by this library.
 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[non_exhaustive]
 pub enum PusVersion {
     EsaPus = 0,
@@ -150,6 +151,7 @@ pub enum PfcReal {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum PusError {
     VersionNotSupported(PusVersion),
     ChecksumFailure(u16),

src/ecss/tc.rs

@@ -59,6 +59,7 @@ pub trait IsPusTelecommand {}
 
 #[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 enum AckOpts {
     Acceptance = 0b1000,
@@ -144,6 +145,7 @@ pub mod zc {
 
 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PusTcSecondaryHeader {
     pub service: u8,
     pub subservice: u8,
@@ -220,6 +222,7 @@ impl PusTcSecondaryHeader {
 /// There is no spare bytes support yet.
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PusTcCreator<'raw_data> {
     sp_header: SpHeader,
     pub sec_header: PusTcSecondaryHeader,
@@ -264,13 +267,13 @@ impl<'raw_data> PusTcCreator<'raw_data> {
         sph: &mut SpHeader,
         service: u8,
         subservice: u8,
-        app_data: Option<&'raw_data [u8]>,
+        app_data: &'raw_data [u8],
         set_ccsds_len: bool,
     ) -> Self {
         Self::new(
             sph,
             PusTcSecondaryHeader::new(service, subservice, ACK_ALL, 0),
-            app_data.unwrap_or(&[]),
+            app_data,
             set_ccsds_len,
         )
     }
@@ -421,6 +424,7 @@ impl IsPusTelecommand for PusTcCreator<'_> {}
 /// * `'raw_data` - Lifetime of the provided raw slice.
 #[derive(Eq, Copy, Clone, Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PusTcReader<'raw_data> {
     #[cfg_attr(feature = "serde", serde(skip))]
     raw_data: &'raw_data [u8],
@@ -571,12 +575,12 @@ mod tests {
 
     fn base_ping_tc_simple_ctor() -> PusTcCreator<'static> {
         let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
-        PusTcCreator::new_simple(&mut sph, 17, 1, None, true)
+        PusTcCreator::new_simple(&mut sph, 17, 1, &[], true)
     }
 
     fn base_ping_tc_simple_ctor_with_app_data(app_data: &'static [u8]) -> PusTcCreator<'static> {
         let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
-        PusTcCreator::new_simple(&mut sph, 17, 1, Some(app_data), true)
+        PusTcCreator::new_simple(&mut sph, 17, 1, app_data, true)
     }
 
     #[test]
@@ -633,7 +637,7 @@ mod tests {
     #[test]
     fn test_update_func() {
         let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
-        let mut tc = PusTcCreator::new_simple(&mut sph, 17, 1, None, false);
+        let mut tc = PusTcCreator::new_simple(&mut sph, 17, 1, &[], false);
         assert_eq!(tc.data_len(), 0);
         tc.update_ccsds_data_len();
         assert_eq!(tc.data_len(), 6);

src/ecss/tm.rs

@@ -115,6 +115,7 @@ pub mod zc {
 
 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PusTmSecondaryHeader<'stamp> {
     pus_version: PusVersion,
     pub sc_time_ref_status: u8,
@@ -122,17 +123,17 @@ pub struct PusTmSecondaryHeader<'stamp> {
     pub subservice: u8,
     pub msg_counter: u16,
     pub dest_id: u16,
-    pub timestamp: &'stamp [u8],
+    pub time_stamp: &'stamp [u8],
 }
 
 impl<'stamp> PusTmSecondaryHeader<'stamp> {
-    pub fn new_simple(service: u8, subservice: u8, timestamp: &'stamp [u8]) -> Self {
-        Self::new(service, subservice, 0, 0, Some(timestamp))
+    pub fn new_simple(service: u8, subservice: u8, time_stamp: &'stamp [u8]) -> Self {
+        Self::new(service, subservice, 0, 0, time_stamp)
     }
 
     /// Like [Self::new_simple] but without a timestamp.
     pub fn new_simple_no_timestamp(service: u8, subservice: u8) -> Self {
-        Self::new(service, subservice, 0, 0, None)
+        Self::new(service, subservice, 0, 0, &[])
     }
 
     pub fn new(
@@ -140,7 +141,7 @@ impl<'stamp> PusTmSecondaryHeader<'stamp> {
         subservice: u8,
         msg_counter: u16,
         dest_id: u16,
-        timestamp: Option<&'stamp [u8]>,
+        time_stamp: &'stamp [u8],
     ) -> Self {
         PusTmSecondaryHeader {
             pus_version: PusVersion::PusC,
@@ -149,7 +150,7 @@ impl<'stamp> PusTmSecondaryHeader<'stamp> {
             subservice,
             msg_counter,
             dest_id,
-            timestamp: timestamp.unwrap_or(&[]),
+            time_stamp,
         }
     }
 }
@@ -191,7 +192,7 @@ impl<'slice> TryFrom<zc::PusTmSecHeader<'slice>> for PusTmSecondaryHeader<'slice
             subservice: sec_header.zc_header.subservice(),
             msg_counter: sec_header.zc_header.msg_counter(),
             dest_id: sec_header.zc_header.dest_id(),
-            timestamp: sec_header.timestamp,
+            time_stamp: sec_header.timestamp,
         })
     }
 }
@@ -210,9 +211,10 @@ impl<'slice> TryFrom<zc::PusTmSecHeader<'slice>> for PusTmSecondaryHeader<'slice
 /// * `'raw_data` - This is the lifetime of the user provided time stamp and source data.
 #[derive(Eq, Debug, Copy, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PusTmCreator<'time, 'raw_data> {
     pub sp_header: SpHeader,
-     #[cfg_attr(feature="serde", serde(borrow))]
+    #[cfg_attr(feature = "serde", serde(borrow))]
     pub sec_header: PusTmSecondaryHeader<'time>,
     source_data: &'raw_data [u8],
     /// If this is set to false, a manual call to [Self::calc_own_crc16] or
@@ -282,7 +284,7 @@ impl<'time, 'raw_data> PusTmCreator<'time, 'raw_data> {
     }
 
     pub fn timestamp(&self) -> &[u8] {
-        self.sec_header.timestamp
+        self.sec_header.time_stamp
     }
 
     pub fn source_data(&self) -> &[u8] {
@@ -321,7 +323,7 @@ impl<'time, 'raw_data> PusTmCreator<'time, 'raw_data> {
         digest.update(sph_zc.as_bytes());
         let pus_tc_header = zc::PusTmSecHeaderWithoutTimestamp::try_from(self.sec_header).unwrap();
         digest.update(pus_tc_header.as_bytes());
-        digest.update(self.sec_header.timestamp);
+        digest.update(self.sec_header.time_stamp);
         digest.update(self.source_data);
         digest.finalize()
     }
@@ -350,9 +352,9 @@ impl<'time, 'raw_data> PusTmCreator<'time, 'raw_data> {
             .write_to_bytes(&mut slice[curr_idx..curr_idx + sec_header_len])
             .ok_or(ByteConversionError::ZeroCopyToError)?;
         curr_idx += sec_header_len;
-        slice[curr_idx..curr_idx + self.sec_header.timestamp.len()]
-            .copy_from_slice(self.sec_header.timestamp);
-        curr_idx += self.sec_header.timestamp.len();
+        slice[curr_idx..curr_idx + self.sec_header.time_stamp.len()]
+            .copy_from_slice(self.sec_header.time_stamp);
+        curr_idx += self.sec_header.time_stamp.len();
         slice[curr_idx..curr_idx + self.source_data.len()].copy_from_slice(self.source_data);
         curr_idx += self.source_data.len();
         let mut digest = CRC_CCITT_FALSE.digest();
@@ -366,14 +368,15 @@ impl<'time, 'raw_data> PusTmCreator<'time, 'raw_data> {
     #[cfg(feature = "alloc")]
     pub fn append_to_vec(&self, vec: &mut Vec<u8>) -> Result<usize, PusError> {
         let sph_zc = crate::zc::SpHeader::from(self.sp_header);
-        let mut appended_len = PUS_TM_MIN_LEN_WITHOUT_SOURCE_DATA + self.sec_header.timestamp.len();
+        let mut appended_len =
+            PUS_TM_MIN_LEN_WITHOUT_SOURCE_DATA + self.sec_header.time_stamp.len();
         appended_len += self.source_data.len();
         let start_idx = vec.len();
         vec.extend_from_slice(sph_zc.as_bytes());
         // The PUS version is hardcoded to PUS C
         let sec_header = zc::PusTmSecHeaderWithoutTimestamp::try_from(self.sec_header).unwrap();
         vec.extend_from_slice(sec_header.as_bytes());
-        vec.extend_from_slice(self.sec_header.timestamp);
+        vec.extend_from_slice(self.sec_header.time_stamp);
         vec.extend_from_slice(self.source_data);
         let mut digest = CRC_CCITT_FALSE.digest();
         digest.update(&vec[start_idx..start_idx + appended_len - 2]);
@@ -385,7 +388,7 @@ impl<'time, 'raw_data> PusTmCreator<'time, 'raw_data> {
 impl WritablePusPacket for PusTmCreator<'_, '_> {
     fn len_written(&self) -> usize {
         PUS_TM_MIN_LEN_WITHOUT_SOURCE_DATA
-            + self.sec_header.timestamp.len()
+            + self.sec_header.time_stamp.len()
             + self.source_data.len()
     }
     /// Write the raw PUS byte representation to a provided buffer.
@@ -449,6 +452,7 @@ impl IsPusTelemetry for PusTmCreator<'_, '_> {}
 /// * `'raw_data` - Lifetime of the raw slice this class is constructed from.
 #[derive(Eq, Debug, Copy, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PusTmReader<'raw_data> {
     pub sp_header: SpHeader,
     pub sec_header: PusTmSecondaryHeader<'raw_data>,
@@ -523,7 +527,7 @@ impl<'raw_data> PusTmReader<'raw_data> {
     }
 
     pub fn timestamp(&self) -> &[u8] {
-        self.sec_header.timestamp
+        self.sec_header.time_stamp
     }
 
     /// This function will return the slice [Self] was constructed from.
@@ -1143,7 +1147,7 @@ mod tests {
     #[test]
     fn test_sec_header_without_stamp() {
         let sec_header = PusTmSecondaryHeader::new_simple_no_timestamp(17, 1);
-        assert_eq!(sec_header.timestamp, &[]);
+        assert_eq!(sec_header.time_stamp, &[]);
     }
 
     #[test]

src/lib.rs

@@ -36,7 +36,11 @@
 //! ### Optional features
 //!
 //!  - [`serde`](https://serde.rs/): Adds `serde` support for most types by adding `Serialize` and
-//!    `Deserialize` `derive`s
+//!    `Deserialize` `derives.
+//!  - [`chrono`](https://crates.io/crates/chrono): Add basic support for the `chrono` time library.
+//!  - [`timelib`](https://crates.io/crates/time): Add basic support for the `time` time library.
+//!  - [`defmt`](https://defmt.ferrous-systems.com/): Add support for the `defmt` by adding the
+//!    [`defmt::Format`](https://defmt.ferrous-systems.com/format) derive on many types.
 //!
 //! ## Module
 //!
@@ -55,7 +59,7 @@
 //! println!("{:x?}", &ccsds_buf[0..6]);
 //! ```
 #![no_std]
-#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![cfg_attr(docs_rs, feature(doc_auto_cfg))]
 #[cfg(feature = "alloc")]
 extern crate alloc;
 #[cfg(any(feature = "std", test))]
@@ -93,6 +97,7 @@ pub const MAX_SEQ_COUNT: u16 = 2u16.pow(14) - 1;
 /// Generic error type when converting to and from raw byte slices.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum ByteConversionError {
     /// The passed slice is too small. Returns the passed slice length and expected minimum size
     ToSliceTooSmall {
@@ -142,6 +147,7 @@ impl Error for ByteConversionError {}
 /// CCSDS packet type enumeration.
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum PacketType {
     Tm = 0,
     Tc = 1,
@@ -165,6 +171,7 @@ pub fn packet_type_in_raw_packet_id(packet_id: u16) -> PacketType {
 
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum SequenceFlags {
     ContinuationSegment = 0b00,
     FirstSegment = 0b01,
@@ -192,6 +199,7 @@ impl TryFrom<u8> for SequenceFlags {
 /// of the first two bytes in the CCSDS primary header.
 #[derive(Debug, Eq, Copy, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PacketId {
     pub ptype: PacketType,
     pub sec_header_flag: bool,
@@ -303,6 +311,7 @@ impl From<u16> for PacketId {
 /// third and the fourth byte in the CCSDS primary header.
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PacketSequenceCtrl {
     pub seq_flags: SequenceFlags,
     seq_count: u16,
@@ -463,6 +472,7 @@ pub trait CcsdsPrimaryHeader {
 /// * `data_len` - Data length field occupies the fifth and the sixth byte of the raw header
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct SpHeader {
     pub version: u8,
     pub packet_id: PacketId,
@@ -798,7 +808,7 @@ pub(crate) mod tests {
         let id_default = PacketId::default();
         assert_eq!(id_default.ptype, PacketType::Tm);
         assert_eq!(id_default.apid, 0x000);
-        assert_eq!(id_default.sec_header_flag, false);
+        assert!(!id_default.sec_header_flag);
     }
 
     #[test]
@@ -808,7 +818,7 @@ pub(crate) mod tests {
         let packet_id = packet_id.unwrap();
         assert_eq!(packet_id.apid(), 0x1ff);
         assert_eq!(packet_id.ptype, PacketType::Tc);
-        assert_eq!(packet_id.sec_header_flag, true);
+        assert!(packet_id.sec_header_flag);
         let packet_id_tc = PacketId::tc(true, 0x1ff);
         assert!(packet_id_tc.is_some());
         let packet_id_tc = packet_id_tc.unwrap();

src/time/cds.rs

@@ -78,6 +78,7 @@ impl ProvidesDaysLength for DaysLen24Bits {
 
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum LengthOfDaySegment {
     Short16Bits = 0,
     Long24Bits = 1,
@@ -94,6 +95,7 @@ pub enum SubmillisPrecision {
 
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum CdsError {
     /// CCSDS days value exceeds maximum allowed size or is negative
     InvalidCcsdsDays(i64),

src/time/cuc.rs

@@ -37,6 +37,7 @@ pub const MAX_CUC_LEN_SMALL_PREAMBLE: usize = 8;
 
 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum FractionalResolution {
     /// No fractional part, only second resolution
     Seconds = 0,
@@ -105,6 +106,7 @@ pub fn fractional_part_from_subsec_ns(res: FractionalResolution, ns: u64) -> Fra
 
 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum CucError {
     InvalidCounterWidth(u8),
     /// Invalid counter supplied.

src/time/mod.rs

@@ -33,6 +33,7 @@ pub const NANOS_PER_SECOND: u32 = 1_000_000_000;
 
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum CcsdsTimeCode {
     CucCcsdsEpoch = 0b001,
     CucAgencyEpoch = 0b010,
@@ -65,6 +66,7 @@ pub fn ccsds_time_code_from_p_field(pfield: u8) -> Result<CcsdsTimeCode, u8> {
 
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct DateBeforeCcsdsEpochError(UnixTime);
 
 impl Display for DateBeforeCcsdsEpochError {
@@ -78,6 +80,7 @@ impl Error for DateBeforeCcsdsEpochError {}
 
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[non_exhaustive]
 pub enum TimestampError {
     InvalidTimeCode { expected: CcsdsTimeCode, found: u8 },
@@ -262,6 +265,7 @@ pub trait CcsdsTimeProvider {
 /// similarly to other common time formats and libraries.
 #[derive(Default, Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct UnixTime {
     secs: i64,
     subsec_nanos: u32,

src/util.rs

@@ -131,6 +131,7 @@ impl Error for UnsignedByteFieldError {}
 /// Type erased variant.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct UnsignedByteField {
     width: usize,
     value: u64,
@@ -220,6 +221,7 @@ impl UnsignedEnum for UnsignedByteField {
 
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct GenericUnsignedByteField<TYPE: Copy + Into<u64>> {
     value: TYPE,
 }