Merge pull request 'added max file segment length calculator' (#109) from file-segment-calculator into main

Reviewed-on: #109

CHANGELOG.md

@@ -25,6 +25,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Added `MsgToUserTlv::to_tlv` converter which reduced the type and converts
   it to a generic `Tlv`.
 - Implemented `From<MsgToUserTlv> for Tlv` converter trait.
+- Added CFDP maximum file segment length calculator method `calculate_max_file_seg_len_for_max_packet_len_and_pdu_header`
 
 ## Added and Changed
 

src/cfdp/pdu/file_data.rs

@@ -411,6 +411,28 @@ impl FileDataPduCreatorWithUnwrittenData<'_> {
     }
 }
 
+/// This function can be used to calculate the maximum allowed file segment size for
+/// a given maximum packet length and the segment metadata if there is any.
+pub fn calculate_max_file_seg_len_for_max_packet_len_and_pdu_header(
+    pdu_header: &PduHeader,
+    max_packet_len: usize,
+    segment_metadata: Option<&SegmentMetadata>,
+) -> usize {
+    let mut subtract = pdu_header.header_len();
+    if segment_metadata.is_some() {
+        subtract += 1 + segment_metadata.as_ref().unwrap().metadata().unwrap().len();
+    }
+    if pdu_header.common_pdu_conf().file_flag == LargeFileFlag::Large {
+        subtract += 8;
+    } else {
+        subtract += 4;
+    }
+    if pdu_header.common_pdu_conf().crc_flag == CrcFlag::WithCrc {
+        subtract += 2;
+    }
+    max_packet_len.saturating_sub(subtract)
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -737,4 +759,56 @@ mod tests {
             }
         }
     }
+
+    #[test]
+    fn test_max_file_seg_calculator_0() {
+        let pdu_header = PduHeader::new_for_file_data_default(CommonPduConfig::default(), 0);
+        assert_eq!(
+            calculate_max_file_seg_len_for_max_packet_len_and_pdu_header(&pdu_header, 64, None),
+            53
+        );
+    }
+
+    #[test]
+    fn test_max_file_seg_calculator_1() {
+        let common_conf = CommonPduConfig {
+            crc_flag: CrcFlag::WithCrc,
+            ..Default::default()
+        };
+        let pdu_header = PduHeader::new_for_file_data_default(common_conf, 0);
+        assert_eq!(
+            calculate_max_file_seg_len_for_max_packet_len_and_pdu_header(&pdu_header, 64, None),
+            51
+        );
+    }
+
+    #[test]
+    fn test_max_file_seg_calculator_2() {
+        let common_conf = CommonPduConfig {
+            file_flag: LargeFileFlag::Large,
+            ..Default::default()
+        };
+        let pdu_header = PduHeader::new_for_file_data_default(common_conf, 0);
+        assert_eq!(
+            calculate_max_file_seg_len_for_max_packet_len_and_pdu_header(&pdu_header, 64, None),
+            49
+        );
+    }
+
+    #[test]
+    fn test_max_file_seg_calculator_saturating_sub() {
+        let common_conf = CommonPduConfig {
+            file_flag: LargeFileFlag::Large,
+            ..Default::default()
+        };
+        let pdu_header = PduHeader::new_for_file_data_default(common_conf, 0);
+        assert_eq!(
+            calculate_max_file_seg_len_for_max_packet_len_and_pdu_header(&pdu_header, 15, None),
+            0
+        );
+        assert_eq!(
+            calculate_max_file_seg_len_for_max_packet_len_and_pdu_header(&pdu_header, 14, None),
+            0
+        );
+    }
 }