codeq 0.5.2

Codec trait
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

use std::ops::Deref;

use derive_more::Add;
use derive_more::AddAssign;
use derive_more::Display;
use derive_more::From;
use derive_more::Sub;
use derive_more::SubAssign;

/// Represents a size in bytes.
///
/// This type wraps a `u64` to provide type safety and prevent accidental mixing
/// of sizes with other numeric values. It supports basic arithmetic operations
/// and comparison.
///
/// # Examples
/// ```rust
/// use codeq::Size;
///
/// let size = Size(1024);
/// let doubled = size + size;
/// assert_eq!(doubled, Size(2048));
///
/// // Sizes can be compared
/// assert!(Size(100) > Size(50));
///
/// // Can be created from u64
/// let size = Size::from(2048u64);
/// ```
#[derive(Debug, Clone, Copy, Default)]
#[derive(PartialEq, Eq, PartialOrd, Ord)]
#[derive(From)]
#[derive(Add, AddAssign, Sub, SubAssign)]
#[derive(Display)]
#[display("Size({_0})")]
pub struct Size(pub u64);

impl Deref for Size {
    type Target = u64;

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

#[cfg(test)]
mod tests {
    use super::Size;

    #[test]
    fn test_display() {
        assert_eq!(format!("{:?}", Size(42)), "Size(42)");
        assert_eq!(format!("{}", Size(42)), "Size(42)");
    }

    #[allow(clippy::clone_on_copy)]
    #[test]
    fn test_calculation() {
        let mut a = Size(42);
        let b = Size(10);

        // Add Sub

        assert_eq!(a + b, Size(52));
        assert_eq!(a - b, Size(32));

        a += b;
        assert_eq!(a, Size(52));
        a -= b;
        assert_eq!(a, Size(42));

        // Eq, Ord

        assert_eq!(a, Size(42));
        assert!(a > b);

        // From

        let c = Size::from(1u64);

        // Clone Copy

        let d = c.clone();
        assert_eq!(d, c);

        let d = c;
        assert_eq!(d, c);

        // Default

        assert_eq!(Size::default(), Size(0));

        // Deref

        assert_eq!(*Size(1u64), 1u64);
    }
}