ufo 0.1.0

unsigned floats
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

#![cfg_attr(feature = "nightly", feature(try_from))]

//! This crate provides unsigned floats by defining two wrappers - a UF32 and UF64.
//! The type is equivalent to storing a positive number of the underlying type (f32 or f64)
//! and no optimisations have been carried out to use the sign bit to store another bit of
//! the data.
//!
//! ## Installation
//!
//! To use this as a dependency, add it to your Cargo.toml file:
//!
//! ```toml
//! ufo = "0.1"
//! ```
//!
//! If you need serialization, enable the serde feature
//! ```toml
//! ufo = { version = "0.1", features = ["serde"] }
//! ```
//!
//! There is also a nightly feature that takes advantage of the TryFrom/TryInto traits
//!
//! ## Usage
//!
//! ```rust
//! use ufo::Uf32;
//!
//! fn main() {
//!     let a = Uf32::try_new(1.0).expect("invalid number");
//!     let b = Uf32::try_new(2.0).expect("invalid number");
//!     assert_eq!(a + b, Uf32::try_new(3.0).expect("invalid number"))
//! }
//! ```
//!

use std::error::Error;
use std::fmt::{Display, Formatter, Result as FmtResult};
use std::ops::{Deref, DerefMut};

#[cfg(feature = "nightly")]
use std::convert::TryFrom;

#[cfg(feature = "serde")]
use serde::{Serialize, Deserialize};

#[doc(hidden)]
pub mod math;

#[derive(Clone, Copy, PartialEq, PartialOrd, Debug, Default)]
#[cfg_attr(feature="serde", derive(Serialize, Deserialize))]
/// Uf32 represents an unsigned f32. You cannot create a new value directly
/// and have to use the `try_new()` method or by calling `try_into` on a f32,
/// where a check is made to ensure that the value is positive.
///
/// Uf32 implements most of the common traits that are implemented on f32 so they
/// can be used directly. This includes addition, subtraction, multiplication,
/// division along with the assignment functions (+=, *=, etc).
pub struct Uf32(f32);

impl Uf32 {
    /// Creates a new Uf32. The function returns a `InvalidNumberError` if a negative
    /// or other invalid numbers are passed to the function. This function should be used
    /// since it is not possible to create a Uf32 directly (i.e. `Uf32(2.0)` will fail
    /// to compile.
    pub fn try_new(value: f32) -> Result<Uf32, InvalidNumberError> {
        if value > 0f32 {
            Ok(Uf32(value))
        } else {
            Err(InvalidNumberError(value))
        }
    }

}
#[cfg(not(feature="nightly"))]
/// Polyfill trait that mimics the TryInto trait on stable till it is stabilized.
pub trait TryInto : Sized {
    fn try_into(self) -> Result<Uf32, InvalidNumberError>;

}

#[cfg(not(feature="nightly"))]
impl TryInto for f32 {
    fn try_into(self) -> Result<Uf32, InvalidNumberError> {
        Uf32::try_new(self)
    }
}

impl Display for Uf32 {
    fn fmt(&self, f: &mut Formatter) -> FmtResult {
        write!(f, "{}", &self.0)
    }
}

impl Deref for Uf32 {
    type Target = f32;

    fn deref(&self) -> &<Self as Deref>::Target {
        &self.0
    }
}

impl DerefMut for Uf32 {
    fn deref_mut(&mut self) -> &mut <Self as Deref>::Target {
        &mut self.0
    }
}

#[cfg(feature="nightly")]
impl TryFrom<f32> for Uf32 {
    type Error = InvalidNumberError;

    fn try_from(value: f32) -> Result<Self, <Self as TryFrom<f32>>::Error> {
        Uf32::try_new(value)
    }
}

/// An error that represents either a negative or an invalid number.
#[derive(Clone, Copy, Debug)]
pub struct InvalidNumberError(f32);

impl Display for InvalidNumberError {
    fn fmt(&self, f: &mut Formatter) -> FmtResult {
        write!(f, "{} is invalid for a Uf32.",  &self)
    }
}

impl Error for InvalidNumberError {}

#[cfg(tests)]
mod tests {
    use crate::*;

    #[test]
    fn it_works() {
        let a = Uf32::try_new(1.0).unwrap();
        let b = Uf32::try_new(2.0).unwrap();

        assert_eq!(a + &b, Uf32::try_new(3.0).unwrap());
    }
}