additional docs
Some checks failed
Rust/spacepackets/pipeline/pr-main There was a failure building this commit
Rust/spacepackets/pipeline/head There was a failure building this commit

This commit is contained in:
Robin Müller 2023-08-16 18:01:09 +02:00
parent 081f6e840f
commit 81db36d159
Signed by: muellerr
GPG Key ID: A649FB78196E3849
2 changed files with 6 additions and 0 deletions

View File

@ -11,6 +11,9 @@ pub const MIN_LV_LEN: usize = 1;
/// Generic CFDP length-value (LV) abstraction as specified in CFDP 5.1.8. /// 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 /// # Lifetimes
/// * `data`: If the LV is generated from a raw bytestream, this will be the lifetime of /// * `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, /// the raw bytestream. If the LV is generated from a raw slice or a similar data reference,

View File

@ -72,6 +72,9 @@ impl From<TlvTypeField> for u8 {
/// Generic CFDP type-length-value (TLV) abstraction as specified in CFDP 5.1.9. /// 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 /// # Lifetimes
/// * `data`: If the TLV is generated from a raw bytestream, this will be the lifetime of /// * `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, /// the raw bytestream. If the TLV is generated from a raw slice or a similar data reference,