From d217a669b21f5f33432f4cc139d088da5e953300 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Mon, 12 Jun 2023 04:04:52 +0200 Subject: [PATCH] add more docs --- src/cfdp/pdu/file_data.rs | 3 +++ src/cfdp/pdu/finished.rs | 3 +++ 2 files changed, 6 insertions(+) diff --git a/src/cfdp/pdu/file_data.rs b/src/cfdp/pdu/file_data.rs index 072ba2e..1207a04 100644 --- a/src/cfdp/pdu/file_data.rs +++ b/src/cfdp/pdu/file_data.rs @@ -81,6 +81,9 @@ impl<'seg_meta> SegmentMetadata<'seg_meta> { } } +/// File Data PDU abstraction. +/// +/// For more information, refer to CFDP chapter 5.3. #[derive(Debug, Copy, Clone, PartialEq, Eq)] #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] pub struct FileDataPdu<'seg_meta, 'file_data> { diff --git a/src/cfdp/pdu/finished.rs b/src/cfdp/pdu/finished.rs index 46e6db4..5b14a72 100644 --- a/src/cfdp/pdu/finished.rs +++ b/src/cfdp/pdu/finished.rs @@ -26,6 +26,9 @@ pub enum FileStatus { Unreported = 0b11, } +/// Finished PDU abstraction. +/// +/// For more information, refer to CFDP chapter 5.2.3. #[derive(Debug, Copy, Clone, PartialEq, Eq)] #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] pub struct FinishedPdu<'fs_responses> {