snarkvm_console_program/locator/
serialize.rs

1// Copyright 2024 Aleo Network Foundation
2// This file is part of the snarkVM library.
3
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at:
7
8// http://www.apache.org/licenses/LICENSE-2.0
9
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15
16use super::*;
17
18impl<N: Network> Serialize for Locator<N> {
19    /// Serializes the locator into string or bytes.
20    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
21        match serializer.is_human_readable() {
22            true => serializer.collect_str(self),
23            false => ToBytesSerializer::serialize_with_size_encoding(self, serializer),
24        }
25    }
26}
27
28impl<'de, N: Network> Deserialize<'de> for Locator<N> {
29    /// Deserializes the locator from a string or bytes.
30    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
31        match deserializer.is_human_readable() {
32            true => FromStr::from_str(&String::deserialize(deserializer)?).map_err(de::Error::custom),
33            false => FromBytesDeserializer::<Self>::deserialize_with_size_encoding(deserializer, "locator"),
34        }
35    }
36}
37
38#[cfg(test)]
39mod tests {
40    use super::*;
41    use snarkvm_console_network::MainnetV0;
42
43    type CurrentNetwork = MainnetV0;
44
45    /// Add test cases here to be checked for serialization.
46    const TEST_CASES: &[&str] = &["testing.aleo/abc", "hello.aleo/u1r02r", "hello_world.aleo/foo", "foo123.aleo/run"];
47
48    fn check_serde_json<
49        T: Serialize + for<'a> Deserialize<'a> + Debug + Display + PartialEq + Eq + FromStr + ToBytes + FromBytes,
50    >(
51        expected: T,
52    ) {
53        // Serialize
54        let expected_string = &expected.to_string();
55        let candidate_string = serde_json::to_string(&expected).unwrap();
56        assert_eq!(expected_string, serde_json::Value::from_str(&candidate_string).unwrap().as_str().unwrap());
57
58        // Deserialize
59        assert_eq!(expected, T::from_str(expected_string).unwrap_or_else(|_| panic!("FromStr: {expected_string}")));
60        assert_eq!(expected, serde_json::from_str(&candidate_string).unwrap());
61    }
62
63    fn check_bincode<
64        T: Serialize + for<'a> Deserialize<'a> + Debug + Display + PartialEq + Eq + FromStr + ToBytes + FromBytes,
65    >(
66        expected: T,
67    ) {
68        // Serialize
69        let expected_bytes = expected.to_bytes_le().unwrap();
70        let expected_bytes_with_size_encoding = bincode::serialize(&expected).unwrap();
71        assert_eq!(&expected_bytes[..], &expected_bytes_with_size_encoding[8..]);
72
73        // Deserialize
74        assert_eq!(expected, T::read_le(&expected_bytes[..]).unwrap());
75        assert_eq!(expected, bincode::deserialize(&expected_bytes_with_size_encoding[..]).unwrap());
76    }
77
78    #[test]
79    fn test_serde_json() {
80        for case in TEST_CASES.iter() {
81            check_serde_json(Locator::<CurrentNetwork>::from_str(case).unwrap());
82        }
83    }
84
85    #[test]
86    fn test_bincode() {
87        for case in TEST_CASES.iter() {
88            check_bincode(Locator::<CurrentNetwork>::from_str(case).unwrap());
89        }
90    }
91}
snarkvm_console_program/locator/serialize.rs

snarkvm_console_program/locator/
serialize.rs
