snarkvm_console_types_string/
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<E: Environment> Serialize for StringType<E> {
19    /// Serializes the string into bytes if the format is not human-readable.
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(self, serializer),
24        }
25    }
26}
27
28impl<'de, E: Environment> Deserialize<'de> for StringType<E> {
29    /// Deserializes the string from bytes, if it is not human-readable.
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_u16(deserializer, "string"),
34        }
35    }
36}
37
38#[cfg(test)]
39mod tests {
40    use super::*;
41    use snarkvm_console_network_environment::Console;
42
43    type CurrentEnvironment = Console;
44
45    const ITERATIONS: u64 = 1000;
46
47    #[test]
48    fn test_serde_json() -> Result<()> {
49        let mut rng = TestRng::default();
50
51        for _ in 0..ITERATIONS {
52            // Sample a new string.
53            let expected = StringType::<CurrentEnvironment>::rand(&mut rng);
54
55            // Serialize
56            let expected_string = &expected.to_string();
57            let candidate_string = serde_json::to_string(&expected)?;
58            assert_eq!(expected_string, serde_json::Value::from_str(&candidate_string)?.as_str().unwrap());
59
60            // Deserialize
61            assert_eq!(expected, StringType::from_str(expected_string)?);
62            assert_eq!(expected, serde_json::from_str(&candidate_string)?);
63        }
64        Ok(())
65    }
66
67    #[test]
68    fn test_bincode() -> Result<()> {
69        let mut rng = TestRng::default();
70
71        for _ in 0..ITERATIONS {
72            // Sample a new string.
73            let expected = StringType::<CurrentEnvironment>::rand(&mut rng);
74
75            // Serialize
76            let expected_bytes = expected.to_bytes_le()?;
77            assert_eq!(&expected_bytes[..], &bincode::serialize(&expected)?[..]);
78
79            // Deserialize
80            assert_eq!(expected, StringType::read_le(&expected_bytes[..])?);
81            assert_eq!(expected, bincode::deserialize(&expected_bytes[..])?);
82        }
83        Ok(())
84    }
85}
snarkvm_console_types_string/serialize.rs

snarkvm_console_types_string/
serialize.rs
