qfall-math 0.1.1

Mathematical foundations for rapid prototyping of lattice-based cryptography
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

// Copyright © 2023 Marvin Beckmann
//
// This file is part of qFALL-math.
//
// qFALL-math is free software: you can redistribute it and/or modify it under
// the terms of the Mozilla Public License Version 2.0 as published by the
// Mozilla Foundation. See <https://mozilla.org/en-US/MPL/2.0/>.

//! This module contains implementations of functions
//! important for serialization such as the [`Serialize`] and [`Deserialize`] trait.
//!
//! The explicit functions contain the documentation.

use super::Z;
use crate::macros::serialize::{deserialize, serialize};
use core::fmt;
use serde::{
    Deserialize, Serialize,
    de::{Error, MapAccess, Unexpected, Visitor},
    ser::SerializeStruct,
};
use std::str::FromStr;

serialize!("value", Z);
deserialize!("value", Value, Z);

#[cfg(test)]
mod test_serialize {
    use crate::integer::Z;
    use std::str::FromStr;

    /// Tests whether the serialization of a positive [`Z`] works.
    #[test]
    fn serialize_output_positive() {
        let z = Z::from(17);
        let cmp_str = "{\"value\":\"17\"}";

        assert_eq!(cmp_str, serde_json::to_string(&z).unwrap());
    }

    /// Tests whether the serialization of a negative [`Z`] works.
    #[test]
    fn serialize_output_negative() {
        let z = Z::from(-17);
        let cmp_str = "{\"value\":\"-17\"}";

        assert_eq!(cmp_str, serde_json::to_string(&z).unwrap());
    }

    /// Tests whether the serialization of a positive large [`Z`] works.
    #[test]
    fn serialize_output_positive_large() {
        let val_str = u64::MAX.to_string();
        let z = Z::from_str(&val_str).unwrap();
        let cmp_str = format!("{{\"value\":\"{val_str}\"}}");

        assert_eq!(cmp_str, serde_json::to_string(&z).unwrap());
    }

    /// Tests whether the serialization of a negative large [`Z`] works.
    #[test]
    fn serialize_output_negative_large() {
        let val_str = format!("-{}", u64::MAX);
        let z = Z::from_str(&val_str).unwrap();
        let cmp_str = format!("{{\"value\":\"{val_str}\"}}");

        assert_eq!(cmp_str, serde_json::to_string(&z).unwrap());
    }
}

#[cfg(test)]
mod test_deserialize {
    use crate::integer::Z;
    use std::str::FromStr;

    /// Tests whether the deserialization of a positive [`Z`] works.
    #[test]
    fn deserialize_positive() {
        let z_string = "{\"value\":\"17\"}";
        assert_eq!(Z::from(17), serde_json::from_str::<Z>(z_string).unwrap());
    }

    /// Tests whether the deserialization of a negative [`Z`] works.
    #[test]
    fn deserialize_negative() {
        let z_string = "{\"value\":\"-17\"}";
        assert_eq!(Z::from(-17), serde_json::from_str::<Z>(z_string).unwrap());
    }

    /// Tests whether the deserialization of a positive large [`Z`] works.
    #[test]
    fn deserialize_positive_large() {
        let val_str = u64::MAX.to_string();
        let z_string = format!("{{\"value\":\"{val_str}\"}}");

        assert_eq!(
            Z::from_str(&val_str).unwrap(),
            serde_json::from_str::<Z>(&z_string).unwrap()
        )
    }

    /// Tests whether the deserialization of a negative large [`Z`] works.
    #[test]
    fn deserialize_negative_large() {
        let val_str = format!("-{}", u64::MAX);
        let z_string = format!("{{\"value\":\"{val_str}\"}}");

        assert_eq!(
            Z::from_str(&val_str).unwrap(),
            serde_json::from_str::<Z>(&z_string).unwrap()
        )
    }

    /// Tests whether no fields 'value' provided yield an error
    #[test]
    fn no_field_value() {
        let a: Result<Z, serde_json::Error> = serde_json::from_str("{{\"tree\":\"{17}\"}}");
        assert!(a.is_err());

        let b: Result<Z, serde_json::Error> = serde_json::from_str("{{}}");
        assert!(b.is_err());
    }

    /// Tests whether too many fields yield an error
    #[test]
    fn too_many_fields() {
        let a: Result<Z, serde_json::Error> =
            serde_json::from_str("{{\"tree\":\"{17}\", \"value\":\"{17}\"}}");
        assert!(a.is_err());

        let b: Result<Z, serde_json::Error> =
            serde_json::from_str("{{\"value\":\"{}\", \"value\":\"{17}\"}}");
        assert!(b.is_err());
    }
}