seabored 0.1.0

Implementation of the CBOR data format. Implements RFC8949 with the preferred-plus recommendations
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215

use half::f16;

use crate::{
    de::CborDeserialize,
    error::{SeaboredDeError, SeaboredSerError},
    ib::{self, InitialByte},
    io::ReadExt as _,
    ser::CborSerialize,
};

use parsio::{Read, Write};

#[derive(Debug, Clone, PartialEq, PartialOrd)]
#[repr(transparent)]
pub struct CborFloat(f64);

impl From<f16> for CborFloat {
    #[inline(always)]
    fn from(value: f16) -> Self {
        Self(value.to_f64())
    }
}

impl From<f32> for CborFloat {
    #[inline(always)]
    fn from(value: f32) -> Self {
        Self(value as f64)
    }
}

impl From<f64> for CborFloat {
    #[inline(always)]
    fn from(value: f64) -> Self {
        Self(value)
    }
}

impl From<CborFloat> for f64 {
    #[inline(always)]
    fn from(cf: CborFloat) -> f64 {
        cf.0
    }
}

impl std::ops::Deref for CborFloat {
    type Target = f64;

    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl std::ops::DerefMut for CborFloat {
    #[inline(always)]
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl CborFloat {
    #[cfg_attr(feature = "inline-nontrivial", inline)]
    pub fn try_cast_f32(&self) -> Result<f32, SeaboredDeError> {
        let float_f32 = self.0 as f32;
        if float_f32 as f64 == self.0 {
            Ok(float_f32)
        } else {
            Err(SeaboredDeError::FloatPrecisionLoss)
        }
    }

    #[cfg_attr(feature = "inline-nontrivial", inline)]
    pub fn try_cast_f16(&self) -> Result<f16, SeaboredDeError> {
        let float_f16 = f16::from_f64(self.0);
        if float_f16.to_f64() == self.0 {
            Ok(float_f16)
        } else {
            Err(SeaboredDeError::FloatPrecisionLoss)
        }
    }
}

impl CborSerialize for CborFloat {
    #[cfg_attr(feature = "inline-nontrivial", inline)]
    fn cbor_serialize_to<W: Write>(&self, writer: &mut W) -> Result<usize, SeaboredSerError> {
        // We try to cast the inner value to the smallest representation possible by using lossless casts.
        // We use the smallest value type that succeeds in the lossless cast
        let maybe_f16 = Some(f16::from_f64(self.0)).filter(|f16_value| {
            self.0.is_nan() // Special case: in preferred-plus serialization, NaN are *always* encoded as f16
            || f16_value.to_f64() == self.0
        });

        if let Some(f16_value) = maybe_f16 {
            f16_value.cbor_serialize_to(writer)
        } else if let Ok(f32_value) = self.try_cast_f32() {
            f32_value.cbor_serialize_to(writer)
        } else {
            self.0.cbor_serialize_to(writer)
        }
    }
}

impl<'a> CborDeserialize<'a> for CborFloat {
    #[inline]
    fn cbor_deserialize_from<R: Read<'a>>(
        reader: &mut R,
    ) -> Result<Self, crate::error::SeaboredDeError> {
        Ok(Self(f64::cbor_deserialize_from(reader)?))
    }
}

impl<'a> CborDeserialize<'a> for f16 {
    #[cfg_attr(feature = "inline-nontrivial", inline)]
    fn cbor_deserialize_from<R: Read<'a>>(reader: &mut R) -> Result<Self, SeaboredDeError>
    where
        Self: Sized + 'a,
    {
        let ib = InitialByte::cbor_deserialize_from(reader)?;

        match ib.0 {
            ib::consts::IB_FLOAT_16 => Ok(f16::from_bits(reader.read_be_u16()?)),
            _ => Err(SeaboredDeError::IncorrectInitialByte {
                actual: ib.0,
                expected: ib::consts::IB_FLOAT_16,
            }),
        }
    }
}

impl<'a> CborDeserialize<'a> for f32 {
    #[cfg_attr(feature = "inline-nontrivial", inline)]
    fn cbor_deserialize_from<R: Read<'a>>(reader: &mut R) -> Result<Self, SeaboredDeError>
    where
        Self: Sized + 'a,
    {
        let ib = InitialByte::cbor_deserialize_from(reader)?;

        match ib.0 {
            ib::consts::IB_FLOAT_16 => Ok(f16::from_bits(reader.read_be_u16()?).to_f32()),
            ib::consts::IB_FLOAT_32 => Ok(f32::from_bits(reader.read_be_u32()?)),
            _ => Err(SeaboredDeError::IncorrectInitialByte {
                actual: ib.0,
                expected: ib::consts::IB_FLOAT_32,
            }),
        }
    }
}

impl<'a> CborDeserialize<'a> for f64 {
    #[cfg_attr(feature = "inline-nontrivial", inline)]
    fn cbor_deserialize_from<R: Read<'a>>(reader: &mut R) -> Result<Self, SeaboredDeError>
    where
        Self: Sized + 'a,
    {
        let ib = InitialByte::cbor_deserialize_from(reader)?;

        match ib.0 {
            ib::consts::IB_FLOAT_16 => Ok(f16::from_bits(reader.read_be_u16()?).to_f64()),
            ib::consts::IB_FLOAT_32 => Ok(f32::from_bits(reader.read_be_u32()?) as f64),
            ib::consts::IB_FLOAT_64 => Ok(f64::from_bits(reader.read_be_u64()?)),
            _ => Err(SeaboredDeError::IncorrectInitialByte {
                actual: ib.0,
                expected: ib::consts::IB_FLOAT_32,
            }),
        }
    }
}

impl CborSerialize for f16 {
    #[cfg_attr(feature = "inline-nontrivial", inline)]
    fn cbor_serialize_to<W: Write>(&self, writer: &mut W) -> Result<usize, SeaboredSerError> {
        let mut buf = [ib::consts::IB_FLOAT_16, 0, 0];
        buf[1..].copy_from_slice(&self.to_be_bytes());
        writer.write(&buf).map_err(Into::into)
    }
}

impl CborSerialize for f32 {
    #[cfg_attr(feature = "inline-nontrivial", inline)]
    fn cbor_serialize_to<W: Write>(&self, writer: &mut W) -> Result<usize, SeaboredSerError> {
        // Special case: in preferred-plus serialization, NaN are *always* encoded as f16
        if self.is_nan() {
            return f16::NAN.cbor_serialize_to(writer);
        }

        let maybe_f16_value =
            Some(f16::from_f32(*self)).filter(|f16_value| &f16_value.to_f32() == self);

        if let Some(f16_value) = maybe_f16_value {
            return f16_value.cbor_serialize_to(writer);
        }

        let mut buf = [ib::consts::IB_FLOAT_32, 0, 0, 0, 0];
        buf[1..].copy_from_slice(&self.to_be_bytes());
        writer.write(&buf).map_err(Into::into)
    }
}

impl CborSerialize for f64 {
    #[cfg_attr(feature = "inline-nontrivial", inline)]
    fn cbor_serialize_to<W: Write>(&self, writer: &mut W) -> Result<usize, SeaboredSerError> {
        // Special case: in preferred-plus serialization, NaN are *always* encoded as f16
        if self.is_nan() {
            return f16::NAN.cbor_serialize_to(writer);
        }

        if let Some(f32v) = Some(*self as f32).filter(|f32v| *f32v as f64 == *self) {
            return f32v.cbor_serialize_to(writer);
        }

        let mut buf = [ib::consts::IB_FLOAT_64, 0, 0, 0, 0, 0, 0, 0, 0];
        buf[1..].copy_from_slice(&self.to_be_bytes());
        writer.write(&buf).map_err(Into::into)
    }
}