lilliput-core 0.1.0

#[cfg(any(test, feature = "testing"))]
use proptest::prelude::*;
#[cfg(any(test, feature = "testing"))]
use proptest_derive::Arbitrary;

use crate::binary::BytesSlice;

/// Represents a byte sequence.
#[cfg_attr(any(test, feature = "testing"), derive(Arbitrary))]
#[derive(Default, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct BytesValue(pub Vec<u8>);

impl BytesValue {
    /// Returns a slice, referencing the inner vec.
    pub fn as_slice(&self) -> &[u8] {
        &self.0
    }

    /// Returns the internal vec, consuming `self`.
    pub fn into_vec(self) -> Vec<u8> {
        self.0
    }

    /// Returns the length of the internal vec.
    pub fn len(&self) -> usize {
        self.0.len()
    }

    /// Returns `true`, if the internal vec is empty, otherwise `false`.
    pub fn is_empty(&self) -> bool {
        self.0.is_empty()
    }
}

impl From<Vec<u8>> for BytesValue {
    fn from(value: Vec<u8>) -> Self {
        Self(value)
    }
}

impl<'a> From<&'a BytesValue> for &'a [u8] {
    fn from(value: &'a BytesValue) -> Self {
        &value.0
    }
}

impl From<BytesValue> for Vec<u8> {
    fn from(value: BytesValue) -> Self {
        value.0
    }
}

impl std::fmt::Debug for BytesValue {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Debug::fmt(&BytesSlice(&self.0), f)
    }
}

impl std::fmt::Display for BytesValue {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Display::fmt(&BytesSlice(&self.0), f)
    }
}

#[cfg(feature = "serde")]
impl serde::Serialize for BytesValue {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serde_bytes::Bytes::new(&self.0).serialize(serializer)
    }
}

#[cfg(feature = "serde")]
impl<'de> serde::Deserialize<'de> for BytesValue {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        Ok(Self(
            serde_bytes::ByteBuf::deserialize(deserializer)?.into_vec(),
        ))
    }
}

#[cfg(test)]
mod tests {
    use proptest::prelude::*;
    use test_log::test;

    use crate::{
        config::EncoderConfig,
        decoder::Decoder,
        encoder::Encoder,
        io::{SliceReader, VecWriter},
        value::Value,
    };

    use super::*;

    #[test]
    fn display() {
        assert_eq!(
            format!("{}", BytesValue::from(vec![1, 2, 3])),
            "[01, 02, 03]"
        );
    }

    #[test]
    fn debug() {
        assert_eq!(
            format!("{:?}", BytesValue::from(vec![1, 2, 3])),
            "[00000001, 00000010, 00000011]"
        );

        assert_eq!(
            format!("{:#?}", BytesValue::from(vec![1, 2, 3])),
            "[0b00000001, 0b00000010, 0b00000011]"
        );
    }

    proptest! {
        #[test]
        fn encode_decode_roundtrip(value in BytesValue::arbitrary(), config in EncoderConfig::arbitrary()) {
            let mut encoded: Vec<u8> = Vec::new();
            let writer = VecWriter::new(&mut encoded);
            let mut encoder = Encoder::new(writer, config);
            encoder.encode_bytes(value.as_slice()).unwrap();

            prop_assert!(encoded.len() <= 1 + 8 + value.len());

            let reader = SliceReader::new(&encoded);
            let mut decoder = Decoder::from_reader(reader);
            let decoded = decoder.decode_bytes_buf().unwrap();
            prop_assert_eq!(&decoded, value.as_slice());

            let reader = SliceReader::new(&encoded);
            let mut decoder = Decoder::from_reader(reader);
            let decoded = decoder.decode_value().unwrap();
            let Value::Bytes(decoded) = decoded else {
                panic!("expected bytes value");
            };
            prop_assert_eq!(&decoded, &value);
        }
    }
}