wincode 0.5.3

Fast bincode de/serialization with placement initialization
Documentation
#[cfg(feature = "uuid-serde-compat")]
use crate::len::SeqLen;
#[cfg(not(feature = "uuid-serde-compat"))]
use crate::schema::TypeMeta;
use {
    crate::{
        config::Config,
        error::{ReadResult, WriteResult},
        io::{Reader, Writer},
        schema::{SchemaRead, SchemaWrite},
    },
    core::mem::{MaybeUninit, transmute},
    uuid::Uuid,
};

#[cfg(feature = "uuid")]
unsafe impl<'de, C: Config> SchemaRead<'de, C> for Uuid {
    type Dst = Uuid;

    // serde serializes byte slices as a length-prefixed array.
    // As such, it must fall back to TypeMeta::Dynamic when `uuid-serde-compat`
    // is enabled. Otherwise, we can enable static and zero-copy.
    #[cfg(not(feature = "uuid-serde-compat"))]
    const TYPE_META: TypeMeta = TypeMeta::Static {
        size: size_of::<Uuid>(),
        zero_copy: true,
    };

    #[inline]
    fn read(mut reader: impl Reader<'de>, dst: &mut MaybeUninit<Self::Dst>) -> ReadResult<()> {
        // serde serializes byte slices as a length-prefixed array.
        #[cfg(feature = "uuid-serde-compat")]
        {
            let len = C::LengthEncoding::read(reader.by_ref())?;
            if len != size_of::<Uuid>() {
                return Err(crate::error::invalid_value("Uuid: invalid length prefix"));
            }
        }
        let bytes = reader.take_array::<{ size_of::<Uuid>() }>()?;
        // SAFETY: `Uuid` is a `#[repr(transparent)]` newtype over `uuid::Bytes` (`[u8; 16]`).
        let dst =
            unsafe { transmute::<&mut MaybeUninit<Uuid>, &mut MaybeUninit<uuid::Bytes>>(dst) };
        dst.write(bytes);
        Ok(())
    }
}

#[cfg(feature = "uuid")]
unsafe impl<C: Config> SchemaWrite<C> for Uuid {
    type Src = Uuid;

    // serde serializes byte slices as a length-prefixed array.
    // As such, it must fall back to TypeMeta::Dynamic when `uuid-serde-compat`
    // is enabled. Otherwise we enable static and zero-copy.
    #[cfg(not(feature = "uuid-serde-compat"))]
    const TYPE_META: TypeMeta = TypeMeta::Static {
        size: size_of::<Uuid>(),
        zero_copy: true,
    };

    #[cfg(feature = "uuid-serde-compat")]
    #[inline]
    #[allow(clippy::arithmetic_side_effects)]
    fn size_of(_src: &Self::Src) -> WriteResult<usize> {
        // serde serializes byte slices as a length-prefixed array.
        let len_bytes = C::LengthEncoding::write_bytes_needed(size_of::<Uuid>())?;
        Ok(len_bytes + size_of::<Uuid>())
    }

    #[cfg(not(feature = "uuid-serde-compat"))]
    #[inline]
    fn size_of(_src: &Self::Src) -> WriteResult<usize> {
        Ok(size_of::<Uuid>())
    }

    #[inline]
    fn write(mut writer: impl Writer, src: &Self::Src) -> WriteResult<()> {
        #[cfg(feature = "uuid-serde-compat")]
        C::LengthEncoding::write(writer.by_ref(), size_of::<Uuid>())?;
        writer.write(src.as_bytes())?;
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use {
        crate::{deserialize, proptest_config::proptest_cfg, serialize},
        proptest::prelude::*,
        uuid::{Bytes, Uuid},
    };

    #[cfg(feature = "uuid-serde-compat")]
    #[test]
    fn test_uuid_invalid_length_prefix_errors() {
        use crate::{
            config::{Config, DefaultConfig},
            len::SeqLen,
        };

        let uuid = Uuid::from_bytes([7u8; size_of::<Bytes>()]);
        let tail = 0x42u8;
        let mut serialized = serialize(&(uuid, tail)).unwrap();

        let prefix_len = serialized
            .len()
            .checked_sub(size_of::<Bytes>() + size_of::<u8>())
            .unwrap();

        // Insert one extra byte after the uuid bytes and bump the length prefix so the
        // stream stays self-consistent. The decoder should reject `len != 16`.
        serialized.insert(prefix_len + size_of::<Bytes>(), 0xAA);
        let mut len_prefix = Vec::new();
        <<DefaultConfig as Config>::LengthEncoding as SeqLen<DefaultConfig>>::write(
            &mut len_prefix,
            size_of::<Bytes>() + 1,
        )
        .unwrap();
        assert_eq!(len_prefix.len(), prefix_len);
        serialized[..prefix_len].copy_from_slice(&len_prefix);

        let err = deserialize::<(Uuid, u8)>(&serialized).unwrap_err();
        assert!(matches!(err, crate::error::ReadError::InvalidValue(_)));
    }

    // We can only compare against bincode's serialization if
    // serde compatibility is enabled due to length prefixing.
    #[cfg(feature = "uuid-serde-compat")]
    #[test]
    fn test_uuid_roundtrip_serde_compat() {
        proptest!(proptest_cfg(), |(value: Bytes)| {
            let uuid = uuid::Uuid::from_bytes(value);
            let bincode_serialized = bincode::serialize(&uuid).unwrap();
            let serialized = serialize(&uuid).unwrap();
            prop_assert_eq!(&bincode_serialized, &serialized);
            let deserialized: Uuid = deserialize(&serialized).unwrap();
            let bincode_deserialized: Uuid = bincode::deserialize(&bincode_serialized).unwrap();
            prop_assert_eq!(uuid, deserialized);
            prop_assert_eq!(uuid, bincode_deserialized);
        });
    }

    // We can only compare against bincode's serialization if
    // serde compatibility is enabled due to length prefixing.
    #[cfg(all(feature = "uuid-serde-compat", feature = "alloc"))]
    #[test]
    fn test_uuid_roundtrip_in_sequence_serde_compat() {
        proptest!(proptest_cfg(), |(value: Vec<Bytes>)| {
            let uuids = value.into_iter().map(uuid::Uuid::from_bytes).collect::<Vec<_>>();
            let bincode_serialized = bincode::serialize(&uuids).unwrap();
            let serialized = serialize(&uuids).unwrap();
            prop_assert_eq!(&bincode_serialized, &serialized);
            let deserialized: Vec<Uuid> = deserialize(&serialized).unwrap();
            let bincode_deserialized: Vec<Uuid> = bincode::deserialize(&bincode_serialized).unwrap();
            prop_assert_eq!(&uuids, &deserialized);
            prop_assert_eq!(uuids, bincode_deserialized);
        });
    }

    #[cfg(not(feature = "uuid-serde-compat"))]
    #[test]
    fn test_uuid_roundtrip() {
        proptest!(proptest_cfg(), |(value: Bytes)| {
            let uuid = uuid::Uuid::from_bytes(value);
            let serialized = serialize(&uuid).unwrap();
            let deserialized: Uuid = deserialize(&serialized).unwrap();
            prop_assert_eq!(uuid, deserialized);
        });
    }

    #[cfg(all(not(feature = "uuid-serde-compat"), feature = "alloc"))]
    #[test]
    fn test_uuid_roundtrip_in_sequence() {
        proptest!(proptest_cfg(), |(value: Vec<Bytes>)| {
            let uuids = value.into_iter().map(uuid::Uuid::from_bytes).collect::<Vec<_>>();
            let serialized = serialize(&uuids).unwrap();
            let deserialized: Vec<Uuid> = deserialize(&serialized).unwrap();
            prop_assert_eq!(uuids, deserialized);
        });
    }
}