spacepackets 0.17.0

//! Abstractions for the Message to User CFDP TLV subtype.
#[cfg(feature = "alloc")]
use super::TlvOwned;
use super::{GenericTlv, ReadableTlv, Tlv, TlvLvError, TlvType, TlvTypeField, WritableTlv};
use crate::{
    cfdp::{InvalidTlvTypeFieldError, TlvLvDataTooLargeError},
    ByteConversionError,
};
use delegate::delegate;

/// Message To User TLV structure.
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct MsgToUserTlv<'data> {
    /// Wrapped generic TLV structure.
    pub tlv: Tlv<'data>,
}

impl<'data> MsgToUserTlv<'data> {
    /// Create a new message to user TLV where the type field is set correctly.
    pub fn new(value: &'data [u8]) -> Result<MsgToUserTlv<'data>, TlvLvDataTooLargeError> {
        Ok(Self {
            tlv: Tlv::new(TlvType::MsgToUser, value)?,
        })
    }

    delegate! {
        to self.tlv {
            /// Value field of the TLV.
            pub fn value(&self) -> &[u8];

            /// Helper method to retrieve the length of the value. Simply calls the [slice::len] method of
            /// [Self::value]
            pub fn len_value(&self) -> usize;
            /// Returns the full raw length, including the length byte.
            pub fn len_full(&self) -> usize;
            /// Checks whether the value field is empty.
            pub fn is_empty(&self) -> bool;
            /// If the TLV was generated from a raw bytestream using [Self::from_bytes], the raw start
            /// of the TLV can be retrieved with this method.
            pub fn raw_data(&self) -> Option<&[u8]>;
        }
    }

    /// Is this a standard TLV?
    #[inline]
    pub fn is_standard_tlv(&self) -> bool {
        true
    }

    /// TLV type field.
    #[inline]
    pub fn tlv_type(&self) -> TlvType {
        TlvType::MsgToUser
    }

    /// Check whether this message is a reserved CFDP message like a Proxy Operation Message.
    pub fn is_reserved_cfdp_msg(&self) -> bool {
        if self.value().len() < 4 {
            return false;
        }
        let value = self.value();
        if value[0] == b'c' && value[1] == b'f' && value[2] == b'd' && value[3] == b'p' {
            return true;
        }
        false
    }

    /// This is a thin wrapper around [Tlv::from_bytes] with the additional type check.
    pub fn from_bytes(buf: &'data [u8]) -> Result<MsgToUserTlv<'data>, TlvLvError> {
        let msg_to_user = Self {
            tlv: Tlv::from_bytes(buf)?,
        };
        match msg_to_user.tlv.tlv_type_field() {
            TlvTypeField::Standard(tlv_type) => {
                if tlv_type != TlvType::MsgToUser {
                    return Err(InvalidTlvTypeFieldError {
                        found: tlv_type as u8,
                        expected: Some(TlvType::MsgToUser as u8),
                    }
                    .into());
                }
            }
            TlvTypeField::Custom(raw) => {
                return Err(InvalidTlvTypeFieldError {
                    found: raw,
                    expected: Some(TlvType::MsgToUser as u8),
                }
                .into());
            }
        }
        Ok(msg_to_user)
    }

    /// Convert to a generic [Tlv].
    #[inline]
    pub fn to_tlv(&self) -> Tlv<'data> {
        self.tlv
    }

    /// Convert to an [TlvOwned].
    #[cfg(feature = "alloc")]
    pub fn to_owned(&self) -> TlvOwned {
        self.tlv.to_owned()
    }

    #[inline]
    fn len_written(&self) -> usize {
        self.len_full()
    }

    delegate!(
        to self.tlv {
            /// Write the TLV to a byte buffer.
            pub fn write_to_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError>;
        }
    );
}

impl<'a> From<MsgToUserTlv<'a>> for Tlv<'a> {
    fn from(value: MsgToUserTlv<'a>) -> Tlv<'a> {
        value.to_tlv()
    }
}

impl WritableTlv for MsgToUserTlv<'_> {
    #[inline]
    fn len_written(&self) -> usize {
        self.len_written()
    }

    fn write_to_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError> {
        self.tlv.write_to_bytes(buf)
    }
}

impl GenericTlv for MsgToUserTlv<'_> {
    #[inline]
    fn tlv_type_field(&self) -> TlvTypeField {
        self.tlv.tlv_type_field()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_basic() {
        let custom_value: [u8; 4] = [1, 2, 3, 4];
        let msg_to_user = MsgToUserTlv::new(&custom_value);
        assert!(msg_to_user.is_ok());
        let msg_to_user = msg_to_user.unwrap();
        assert!(msg_to_user.is_standard_tlv());
        assert_eq!(msg_to_user.tlv_type(), TlvType::MsgToUser);
        assert_eq!(
            msg_to_user.tlv_type_field(),
            TlvTypeField::Standard(TlvType::MsgToUser)
        );
        assert_eq!(msg_to_user.value(), custom_value);
        assert_eq!(msg_to_user.value().len(), 4);
        assert_eq!(msg_to_user.len_value(), 4);
        assert_eq!(msg_to_user.len_full(), 6);
        assert!(!msg_to_user.is_empty());
        assert!(msg_to_user.raw_data().is_none());
        assert!(!msg_to_user.is_reserved_cfdp_msg());
    }

    #[test]
    fn test_reserved_msg_serialization() {
        let custom_value: [u8; 4] = [1, 2, 3, 4];
        let msg_to_user = MsgToUserTlv::new(&custom_value).unwrap();
        let mut buf: [u8; 6] = [0; 6];
        msg_to_user.write_to_bytes(&mut buf).unwrap();
        assert_eq!(
            buf,
            [
                TlvType::MsgToUser as u8,
                custom_value.len() as u8,
                1,
                2,
                3,
                4
            ]
        );
    }

    #[test]
    fn test_msg_to_user_type_reduction() {
        let custom_value: [u8; 4] = [1, 2, 3, 4];
        let msg_to_user = MsgToUserTlv::new(&custom_value).unwrap();
        let tlv = msg_to_user.to_tlv();
        assert_eq!(
            tlv.tlv_type_field(),
            TlvTypeField::Standard(TlvType::MsgToUser)
        );

        assert_eq!(tlv.value(), custom_value);
    }

    #[test]
    fn test_msg_to_user_to_tlv() {
        let custom_value: [u8; 4] = [1, 2, 3, 4];
        let msg_to_user = MsgToUserTlv::new(&custom_value).unwrap();
        let tlv: Tlv = msg_to_user.into();
        assert_eq!(msg_to_user.to_tlv(), tlv);
    }

    #[test]
    fn test_msg_to_user_owner_converter() {
        let custom_value: [u8; 4] = [1, 2, 3, 4];
        let msg_to_user = MsgToUserTlv::new(&custom_value).unwrap();
        let tlv = msg_to_user.to_owned();
        assert_eq!(
            tlv.tlv_type_field(),
            TlvTypeField::Standard(TlvType::MsgToUser)
        );

        assert_eq!(tlv.value(), custom_value);
    }

    #[test]
    fn test_reserved_msg_deserialization() {
        let custom_value: [u8; 3] = [1, 2, 3];
        let msg_to_user = MsgToUserTlv::new(&custom_value).unwrap();
        let msg_to_user_vec = msg_to_user.to_vec();
        let msg_to_user_from_bytes = MsgToUserTlv::from_bytes(&msg_to_user_vec).unwrap();
        assert!(!msg_to_user.is_reserved_cfdp_msg());
        assert_eq!(msg_to_user_from_bytes, msg_to_user);
        assert_eq!(msg_to_user_from_bytes.value(), msg_to_user.value());
        assert_eq!(msg_to_user_from_bytes.tlv_type(), msg_to_user.tlv_type());
    }
    #[test]
    fn test_reserved_msg_deserialization_invalid_type() {
        let trash: [u8; 5] = [TlvType::FlowLabel as u8, 3, 1, 2, 3];
        let error = MsgToUserTlv::from_bytes(&trash).unwrap_err();
        if let TlvLvError::InvalidTlvTypeField(inner) = error {
            assert_eq!(inner.found, TlvType::FlowLabel as u8);
            assert_eq!(inner.expected, Some(TlvType::MsgToUser as u8));
        } else {
            panic!("Wrong error type returned: {:?}", error);
        }
    }

    #[test]
    fn test_reserved_msg() {
        let reserved_str = "cfdp";
        let msg_to_user = MsgToUserTlv::new(reserved_str.as_bytes());
        assert!(msg_to_user.is_ok());
        let msg_to_user = msg_to_user.unwrap();
        assert!(msg_to_user.is_reserved_cfdp_msg());
    }
}