Skip to main content

ic_wire/
finite.rs

1//! Explicit finite-float contract over the sole Serde/Postcard codec.
2use crate::Error;
3use serde::{Deserialize, Deserializer, Serialize, Serializer};
4
5macro_rules! finite {
6    ($name:ident, $primitive:ty) => {
7        /// Finite IEEE-754 value. Preserves signed zero and subnormal bits.
8        #[derive(Clone, Copy, Debug, PartialEq, PartialOrd)]
9        pub struct $name($primitive);
10        impl $name {
11            /// Admit a primitive without normalization.
12            /// # Errors
13            /// Returns `Error::Malformed` for NaN or infinity.
14            pub fn new(value: $primitive) -> Result<Self, Error> {
15                if value.is_finite() {
16                    Ok(Self(value))
17                } else {
18                    Err(Error::Malformed)
19                }
20            }
21            /// Return the exact admitted primitive.
22            pub fn get(self) -> $primitive {
23                self.0
24            }
25        }
26        impl Serialize for $name {
27            fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
28                self.0.serialize(serializer)
29            }
30        }
31        impl<'de> Deserialize<'de> for $name {
32            fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
33                Self::new(<$primitive>::deserialize(deserializer)?)
34                    .map_err(|_| serde::de::Error::custom("non-finite float"))
35            }
36        }
37    };
38}
39finite!(FiniteF32, f32);
40finite!(FiniteF64, f64);