diff --git a/README.md b/README.md index ca85e6c..a440074 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ Currently, this includes the following components: - Space Packet implementation according to [CCSDS Blue Book 133.0-B-2](https://public.ccsds.org/Pubs/133x0b2e1.pdf) +- CCSDS File Delivery Protocol (CFDP) packet implementations according to + [CCSDS Blue Book 727.0-B-5](https://public.ccsds.org/Pubs/727x0b5.pdf) - PUS Telecommand and PUS Telemetry implementation according to the [ECSS-E-ST-70-41C standard](https://ecss.nl/standard/ecss-e-st-70-41c-space-engineering-telemetry-and-telecommand-packet-utilization-15-april-2016/). - CUC (CCSDS Unsegmented Time Code) implementation according to diff --git a/src/cfdp/mod.rs b/src/cfdp/mod.rs index 9add59e..bd1d918 100644 --- a/src/cfdp/mod.rs +++ b/src/cfdp/mod.rs @@ -1,3 +1,4 @@ +//! Low-level CCSDS File Delivery Protocol (CFDP) support according to [CCSDS 727.0-B-5](https://public.ccsds.org/Pubs/727x0b5.pdf). use crate::ByteConversionError; use core::fmt::{Display, Formatter}; use num_enum::{IntoPrimitive, TryFromPrimitive}; diff --git a/src/cfdp/pdu/mod.rs b/src/cfdp/pdu/mod.rs index 225874a..148e8d4 100644 --- a/src/cfdp/pdu/mod.rs +++ b/src/cfdp/pdu/mod.rs @@ -392,7 +392,8 @@ impl PduHeader { /// and 4.1.2 because performing the CRC procedure requires the buffer to be large enough /// to hold the full PDU. /// - /// Both functions can however be performed with the [verify_length_and_checksum] function. + /// Both functions can however be performed with the [Self::verify_length_and_checksum] + /// function. pub fn from_bytes(buf: &[u8]) -> Result<(Self, usize), PduError> { if buf.len() < FIXED_HEADER_LEN { return Err(PduError::ByteConversionError( diff --git a/src/cfdp/tlv.rs b/src/cfdp/tlv.rs index 3a44b0b..0efed46 100644 --- a/src/cfdp/tlv.rs +++ b/src/cfdp/tlv.rs @@ -126,7 +126,7 @@ impl<'data> Tlv<'data> { /// Creates a TLV give a raw bytestream. Please note that is is not necessary to pass the /// bytestream with the exact size of the expected TLV. This function will take care /// of parsing the length byte, and the length of the parsed TLV can be retrieved using - /// [len_full]. + /// [Self::len_full]. pub fn from_bytes(buf: &'data [u8]) -> Result, TlvLvError> { generic_len_check_deserialization(buf, MIN_TLV_LEN)?; Ok(Self { diff --git a/src/lib.rs b/src/lib.rs index 5062c18..094322d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -7,6 +7,8 @@ //! //! - Space Packet implementation according to //! [CCSDS Blue Book 133.0-B-2](https://public.ccsds.org/Pubs/133x0b2e1.pdf) +//! - CCSDS File Delivery Protocol (CFDP) packet implementations according to +//! [CCSDS Blue Book 727.0-B-5](https://public.ccsds.org/Pubs/727x0b5.pdf) //! - PUS Telecommand and PUS Telemetry implementation according to the //! [ECSS-E-ST-70-41C standard](https://ecss.nl/standard/ecss-e-st-70-41c-space-engineering-telemetry-and-telecommand-packet-utilization-15-april-2016/). //! - CUC (CCSDS Unsegmented Time Code) implementation according to