ip-v8/rust-ipv8

View on GitHub
rust_ipv8/src/serialization/rawend.rs

Summary

Maintainability
Test Coverage
//! Module containing everything related to RawEnd data structure
use serde;
use serde::de::{Deserialize, Deserializer, SeqAccess, Visitor};
use serde::ser::{Serialize, SerializeStruct, Serializer};
use std::fmt;

/// Datatype representing the raw bytes at the end of an ipv8 payload where the length shouldn't be prefixed.
#[derive(Debug, PartialEq)]
pub struct RawEnd(pub Vec<u8>);

impl Serialize for RawEnd {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut state = serializer.serialize_struct("RawEnd", self.0.len())?;
        for i in &self.0 {
            state.serialize_field("value", &i)?;
        }
        state.end()
    }
}

impl<'de> Deserialize<'de> for RawEnd {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        #[doc(hidden)]
        struct RawEndVisitor;
        impl<'de> Visitor<'de> for RawEndVisitor {
            type Value = RawEnd;
            fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                formatter.write_str("RawEnd")
            }

            fn visit_seq<A>(self, mut seq: A) -> Result<Self::Value, A::Error>
            where
                A: SeqAccess<'de>,
            {
                let mut res: Vec<u8> = vec![];

                while let Ok(item) = seq.next_element() {
                    res.push(match item {
                        Some(i) => i,
                        None => break,
                    })
                }
                Ok(RawEnd(res))
            }
        }
        Ok(deserializer.deserialize_tuple(std::usize::MAX, RawEndVisitor)?)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::payloads::Ipv8Payload;
    use crate::serialization::Packet;
    use serde::{Deserialize, Serialize};

    #[derive(Debug, PartialEq, Serialize, Deserialize)]
    struct TestPayload1 {
        test: RawEnd,
    }

    impl Ipv8Payload for TestPayload1 {
        // doesnt have anything but needed for the default implementation (as of right now)
    }

    #[test]
    fn test_serialize_rawend() {
        let a = TestPayload1 {
            test: RawEnd(vec![42, 43]),
        };

        let mut packet = Packet::new(create_test_header!()).unwrap();

        packet.add(&a).unwrap();

        assert_eq!(
            Packet(vec![
                0, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 42, 42, 43
            ]),
            packet
        );
    }

    #[test]
    fn test_deserialize_rawend() {
        let a = TestPayload1 {
            test: RawEnd(vec![42, 43]),
        };

        let mut packet = Packet::new(create_test_header!()).unwrap();
        packet.add(&a).unwrap();
        assert_eq!(
            a,
            packet
                .start_deserialize()
                .skip_header()
                .unwrap()
                .next_payload()
                .unwrap()
        );
    }
}