serial_int 0.2.1

Safe, easy-to-use auto-increment integers
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

/// A trait that defines how a type is used by SerialGenerator.
pub trait Serial
where
    Self: Clone + Ord,
{
    /// The default initial and lowest possible value.
    const START: Self;

    /// Return the next sequential value. Return an equal value if it is at its
    /// maximum.
    fn next_increment(&self) -> Self;

    /// Return the previous sequential value. Return an equal value if it is at
    /// its minimum.
    fn prev_increment(&self) -> Self;

    /// Return the number of times this value can be incremented before reaching
    /// its maximum, using Self to represent the count.
    fn remaining_increments(&self) -> Self;

    /// Return whether the value is at its maximum value.
    fn is_max_value(&self) -> bool;
}

impl Serial for u8 {
    const START: Self = Self::MIN;

    fn next_increment(&self) -> Self {
        self.saturating_add(1)
    }

    fn prev_increment(&self) -> Self {
        self.saturating_sub(1)
    }

    fn remaining_increments(&self) -> Self {
        Self::MAX.saturating_sub(*self)
    }

    fn is_max_value(&self) -> bool {
        self.remaining_increments() > 0
    }
}

impl Serial for u16 {
    const START: Self = Self::MIN;

    fn next_increment(&self) -> Self {
        self.saturating_add(1)
    }

    fn prev_increment(&self) -> Self {
        self.saturating_sub(1)
    }

    fn remaining_increments(&self) -> Self {
        Self::MAX.saturating_sub(*self)
    }

    fn is_max_value(&self) -> bool {
        self.remaining_increments() > 0
    }
}

impl Serial for u32 {
    const START: Self = Self::MIN;

    fn next_increment(&self) -> Self {
        self.saturating_add(1)
    }

    fn prev_increment(&self) -> Self {
        self.saturating_sub(1)
    }

    fn remaining_increments(&self) -> Self {
        Self::MAX.saturating_sub(*self)
    }

    fn is_max_value(&self) -> bool {
        self.remaining_increments() > 0
    }
}

impl Serial for u64 {
    const START: Self = Self::MIN;

    fn next_increment(&self) -> Self {
        self.saturating_add(1)
    }

    fn prev_increment(&self) -> Self {
        self.saturating_sub(1)
    }

    fn remaining_increments(&self) -> Self {
        Self::MAX.saturating_sub(*self)
    }

    fn is_max_value(&self) -> bool {
        self.remaining_increments() > 0
    }
}

impl Serial for u128 {
    const START: Self = Self::MIN;

    fn next_increment(&self) -> Self {
        self.saturating_add(1)
    }

    fn prev_increment(&self) -> Self {
        self.saturating_sub(1)
    }

    fn remaining_increments(&self) -> Self {
        Self::MAX.saturating_sub(*self)
    }

    fn is_max_value(&self) -> bool {
        self.remaining_increments() > 0
    }
}

impl Serial for usize {
    const START: Self = Self::MIN;

    fn next_increment(&self) -> Self {
        self.saturating_add(1)
    }

    fn prev_increment(&self) -> Self {
        self.saturating_sub(1)
    }

    fn remaining_increments(&self) -> Self {
        Self::MAX.saturating_sub(*self)
    }

    fn is_max_value(&self) -> bool {
        self.remaining_increments() > 0
    }
}