From 81db36d15979e783a341192fa9b3c99c436b7e07 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Wed, 16 Aug 2023 18:01:09 +0200 Subject: [PATCH] additional docs --- src/cfdp/lv.rs | 3 +++ src/cfdp/tlv/mod.rs | 3 +++ 2 files changed, 6 insertions(+) diff --git a/src/cfdp/lv.rs b/src/cfdp/lv.rs index 67c2269..18329ef 100644 --- a/src/cfdp/lv.rs +++ b/src/cfdp/lv.rs @@ -11,6 +11,9 @@ pub const MIN_LV_LEN: usize = 1; /// Generic CFDP length-value (LV) abstraction as specified in CFDP 5.1.8. /// +/// Please note that this class is zero-copy and does not generate a copy of the value data for +/// both the regular [new] constructor and the [Self::from_bytes] constructor. +/// /// # Lifetimes /// * `data`: If the LV is generated from a raw bytestream, this will be the lifetime of /// the raw bytestream. If the LV is generated from a raw slice or a similar data reference, diff --git a/src/cfdp/tlv/mod.rs b/src/cfdp/tlv/mod.rs index d378d4d..d6d2f4b 100644 --- a/src/cfdp/tlv/mod.rs +++ b/src/cfdp/tlv/mod.rs @@ -72,6 +72,9 @@ impl From for u8 { /// Generic CFDP type-length-value (TLV) abstraction as specified in CFDP 5.1.9. /// +/// Please note that this class is zero-copy and does not generate a copy of the value data for +/// both the regular [new] constructor and the [Self::from_bytes] constructor. +/// /// # Lifetimes /// * `data`: If the TLV is generated from a raw bytestream, this will be the lifetime of /// the raw bytestream. If the TLV is generated from a raw slice or a similar data reference,