bxvl 0.1.1

A datatype library that allows for measurement unit association, conversion, and operations for values.
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260

use std::fmt::Display;

use super::{BaseUnit, Convert, Metric, UnitInformation};

impl Display for UnitInformation {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}",
            match self {
                Self::Bit(m) => format!("{}bits", m.as_str()),
                Self::Byte(m) => format!("{}b", m.as_str()),
            }
        )
    }
}

impl From<UnitInformation> for String {
    fn from(val: UnitInformation) -> Self {
        val.to_string()
    }
}

impl Convert<UnitInformation> for UnitInformation {
    /// Returns the `f64` multiplier to convert a `Value`
    fn convert(&self, other: &UnitInformation) -> f64 {
        (self.scale() / other.scale()) * (self.base() / other.base())
    }
}

impl BaseUnit for UnitInformation {
    /// Returns the metric scaler of an SI unit
    fn scale(&self) -> f64 {
        match self {
            UnitInformation::Bit(m) | UnitInformation::Byte(m) => match m {
                Metric::Quetta => 1267650600228229401496703205376.0,
                Metric::Ronna => 1237940039285380274899124224.0,
                Metric::Yotta => 1208925819614629174706176.0,
                Metric::Zetta => 1180591620717411303424.0,
                Metric::Exa => 1152921504606846976.0,
                Metric::Peta => 1125899906842624.0,
                Metric::Tera => 1099511627776.0,
                Metric::Giga => 1073741824.0,
                Metric::Mega => 1048576.0,
                Metric::Kilo => 1024.0,
                Metric::None => 1.0,
                _ => 1.0,
            },
        }
    }

    /// Returns the base unit conversion in relation to the standard SI unit
    fn base(&self) -> f64 {
        match self {
            Self::Byte(_) => 1.0,
            Self::Bit(_) => 0.125,
        }
    }

    /// Returns the `Metric` prefix for the unit
    fn get_metric(&self) -> Metric {
        match self {
            Self::Bit(m) => *m,
            Self::Byte(m) => *m,
        }
    }
}

#[cfg(test)]
mod information_testing {
    use crate::units::{BaseUnit, Metric, information::UnitInformation};

    /// Unit Information Comparison Base
    ///
    /// All units must return the 'base' value relative to the standard SI unit
    #[test]
    fn unit_information_base_comparison() {
        // Bits
        assert!(UnitInformation::Bit(Metric::None).base() == 0.125);
        // Bytes are the base 'SI unit'
        assert!(UnitInformation::Byte(Metric::None).base() == 1.0);
    }

    /// Unit Information string conversion
    ///
    /// All units must be able to convert to a string.
    #[test]
    fn unit_information_to_string() {
        for i in [
            (UnitInformation::Byte(Metric::Ronto), "rb"),
            (UnitInformation::Byte(Metric::Ronna), "Rb"),
            (UnitInformation::Byte(Metric::Quetta), "Qb"),
            (UnitInformation::Byte(Metric::Quecto), "qb"),
            (UnitInformation::Byte(Metric::Atto), "ab"),
            (UnitInformation::Byte(Metric::Centi), "cb"),
            (UnitInformation::Byte(Metric::Deca), "dab"),
            (UnitInformation::Byte(Metric::Deci), "db"),
            (UnitInformation::Byte(Metric::Exa), "Eb"),
            (UnitInformation::Byte(Metric::Femto), "fb"),
            (UnitInformation::Byte(Metric::Giga), "Gb"),
            (UnitInformation::Byte(Metric::Hecto), "hb"),
            (UnitInformation::Byte(Metric::Kilo), "kb"),
            (UnitInformation::Byte(Metric::Mega), "Mb"),
            (UnitInformation::Byte(Metric::Micro), "μb"),
            (UnitInformation::Byte(Metric::Milli), "mb"),
            (UnitInformation::Byte(Metric::Nano), "nb"),
            (UnitInformation::Byte(Metric::None), "b"),
            (UnitInformation::Byte(Metric::Peta), "Pb"),
            (UnitInformation::Byte(Metric::Pico), "pb"),
            (UnitInformation::Byte(Metric::Tera), "Tb"),
            (UnitInformation::Byte(Metric::Yocto), "yb"),
            (UnitInformation::Byte(Metric::Yotta), "Yb"),
            (UnitInformation::Byte(Metric::Zepto), "zb"),
            (UnitInformation::Byte(Metric::Zetta), "Zb"),
            (UnitInformation::Bit(Metric::Ronto), "rbits"),
            (UnitInformation::Bit(Metric::Ronna), "Rbits"),
            (UnitInformation::Bit(Metric::Quetta), "Qbits"),
            (UnitInformation::Bit(Metric::Quecto), "qbits"),
            (UnitInformation::Bit(Metric::Atto), "abits"),
            (UnitInformation::Bit(Metric::Centi), "cbits"),
            (UnitInformation::Bit(Metric::Deca), "dabits"),
            (UnitInformation::Bit(Metric::Deci), "dbits"),
            (UnitInformation::Bit(Metric::Exa), "Ebits"),
            (UnitInformation::Bit(Metric::Femto), "fbits"),
            (UnitInformation::Bit(Metric::Giga), "Gbits"),
            (UnitInformation::Bit(Metric::Hecto), "hbits"),
            (UnitInformation::Bit(Metric::Kilo), "kbits"),
            (UnitInformation::Bit(Metric::Mega), "Mbits"),
            (UnitInformation::Bit(Metric::Micro), "μbits"),
            (UnitInformation::Bit(Metric::Milli), "mbits"),
            (UnitInformation::Bit(Metric::Nano), "nbits"),
            (UnitInformation::Bit(Metric::None), "bits"),
            (UnitInformation::Bit(Metric::Peta), "Pbits"),
            (UnitInformation::Bit(Metric::Pico), "pbits"),
            (UnitInformation::Bit(Metric::Tera), "Tbits"),
            (UnitInformation::Bit(Metric::Yocto), "ybits"),
            (UnitInformation::Bit(Metric::Yotta), "Ybits"),
            (UnitInformation::Bit(Metric::Zepto), "zbits"),
            (UnitInformation::Bit(Metric::Zetta), "Zbits"),
        ] {
            assert_eq!(&i.0.to_string(), i.1);
            let t: String = i.0.into();
            assert_eq!(t, i.1.to_string());
        }
    }

    /// Unit information metric scaling
    ///
    /// All units must return the metric 'scaler' value.
    #[test]
    fn unit_information_scale() {
        for i in [
            (UnitInformation::Byte(Metric::Ronto), Metric::Ronto),
            (UnitInformation::Byte(Metric::Ronna), Metric::Ronna),
            (UnitInformation::Byte(Metric::Quetta), Metric::Quetta),
            (UnitInformation::Byte(Metric::Quecto), Metric::Quecto),
            (UnitInformation::Byte(Metric::Atto), Metric::Atto),
            (UnitInformation::Byte(Metric::Centi), Metric::Centi),
            (UnitInformation::Byte(Metric::Deca), Metric::Deca),
            (UnitInformation::Byte(Metric::Deci), Metric::Deci),
            (UnitInformation::Byte(Metric::Exa), Metric::Exa),
            (UnitInformation::Byte(Metric::Femto), Metric::Femto),
            (UnitInformation::Byte(Metric::Giga), Metric::Giga),
            (UnitInformation::Byte(Metric::Hecto), Metric::Hecto),
            (UnitInformation::Byte(Metric::Kilo), Metric::Kilo),
            (UnitInformation::Byte(Metric::Mega), Metric::Mega),
            (UnitInformation::Byte(Metric::Micro), Metric::Micro),
            (UnitInformation::Byte(Metric::Milli), Metric::Milli),
            (UnitInformation::Byte(Metric::Nano), Metric::Nano),
            (UnitInformation::Byte(Metric::None), Metric::None),
            (UnitInformation::Byte(Metric::Peta), Metric::Peta),
            (UnitInformation::Byte(Metric::Pico), Metric::Pico),
            (UnitInformation::Byte(Metric::Tera), Metric::Tera),
            (UnitInformation::Byte(Metric::Yocto), Metric::Yocto),
            (UnitInformation::Byte(Metric::Yotta), Metric::Yotta),
            (UnitInformation::Byte(Metric::Zepto), Metric::Zepto),
            (UnitInformation::Byte(Metric::Zetta), Metric::Zetta),
            (UnitInformation::Bit(Metric::Ronto), Metric::Ronto),
            (UnitInformation::Bit(Metric::Ronna), Metric::Ronna),
            (UnitInformation::Bit(Metric::Quetta), Metric::Quetta),
            (UnitInformation::Bit(Metric::Quecto), Metric::Quecto),
            (UnitInformation::Bit(Metric::Atto), Metric::Atto),
            (UnitInformation::Bit(Metric::Centi), Metric::Centi),
            (UnitInformation::Bit(Metric::Deca), Metric::Deca),
            (UnitInformation::Bit(Metric::Deci), Metric::Deci),
            (UnitInformation::Bit(Metric::Exa), Metric::Exa),
            (UnitInformation::Bit(Metric::Femto), Metric::Femto),
            (UnitInformation::Bit(Metric::Giga), Metric::Giga),
            (UnitInformation::Bit(Metric::Hecto), Metric::Hecto),
            (UnitInformation::Bit(Metric::Kilo), Metric::Kilo),
            (UnitInformation::Bit(Metric::Mega), Metric::Mega),
            (UnitInformation::Bit(Metric::Micro), Metric::Micro),
            (UnitInformation::Bit(Metric::Milli), Metric::Milli),
            (UnitInformation::Bit(Metric::Nano), Metric::Nano),
            (UnitInformation::Bit(Metric::None), Metric::None),
            (UnitInformation::Bit(Metric::Peta), Metric::Peta),
            (UnitInformation::Bit(Metric::Pico), Metric::Pico),
            (UnitInformation::Bit(Metric::Tera), Metric::Tera),
            (UnitInformation::Bit(Metric::Yocto), Metric::Yocto),
            (UnitInformation::Bit(Metric::Yotta), Metric::Yotta),
            (UnitInformation::Bit(Metric::Zepto), Metric::Zepto),
            (UnitInformation::Bit(Metric::Zetta), Metric::Zetta),
        ] {
            assert_eq!(i.0.get_metric(), i.1);
        }

        for i in [
            (
                UnitInformation::Byte(Metric::Ronna),
                1237940039285380274899124224.0,
            ),
            (
                UnitInformation::Byte(Metric::Quetta),
                1267650600228229401496703205376.0,
            ),
            (UnitInformation::Byte(Metric::Giga), 1073741824.0),
            (UnitInformation::Byte(Metric::Kilo), 1024.0),
            (UnitInformation::Byte(Metric::Mega), 1048576.0),
            (UnitInformation::Byte(Metric::None), 1.0),
            (UnitInformation::Byte(Metric::Peta), 1125899906842624.0),
            (UnitInformation::Byte(Metric::Tera), 1099511627776.0),
            (
                UnitInformation::Byte(Metric::Yotta),
                1208925819614629174706176.0,
            ),
            (
                UnitInformation::Byte(Metric::Zetta),
                1180591620717411303424.0,
            ),
            (UnitInformation::Byte(Metric::Exa), 1152921504606846976.0),
            (UnitInformation::Byte(Metric::Atto), 1.0),
            (
                UnitInformation::Bit(Metric::Ronna),
                1237940039285380274899124224.0,
            ),
            (
                UnitInformation::Bit(Metric::Quetta),
                1267650600228229401496703205376.0,
            ),
            (UnitInformation::Bit(Metric::Giga), 1073741824.0),
            (UnitInformation::Bit(Metric::Kilo), 1024.0),
            (UnitInformation::Bit(Metric::Mega), 1048576.0),
            (UnitInformation::Bit(Metric::None), 1.0),
            (UnitInformation::Bit(Metric::Peta), 1125899906842624.0),
            (UnitInformation::Bit(Metric::Tera), 1099511627776.0),
            (
                UnitInformation::Bit(Metric::Yotta),
                1208925819614629174706176.0,
            ),
            (
                UnitInformation::Bit(Metric::Zetta),
                1180591620717411303424.0,
            ),
            (UnitInformation::Bit(Metric::Exa), 1152921504606846976.0),
            (UnitInformation::Bit(Metric::Atto), 1.0),
        ] {
            assert_eq!(i.0.scale(), i.1);
        }
    }
}