padded-number 0.3.0

Work with numbers containing significant leading zeros
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

# `padded-number` - For numbers containing significant leading zeros

[![ci_status](https://img.shields.io/github/actions/workflow/status/gibbz00/padded-number/ci.yaml?style=for-the-badge)](https://github.com/gibbz00/padded-number/actions/workflows/ci.yaml)
[![codecov](https://img.shields.io/codecov/c/gh/gibbz00/padded-number?token=8uQpdikxPA&style=for-the-badge)](https://codecov.io/gh/gibbz00/padded-number)
[![license](https://img.shields.io/github/license/gibbz00/padded-number.svg?style=for-the-badge)](https://github.com/gibbz00/padded-number/blob/main/LICENSE.md)
[![crates_io](https://img.shields.io/crates/v/padded-number.svg?style=for-the-badge)](https://crates.io/crates/padded-number)
[![docs_rs](https://img.shields.io/docsrs/padded-number/latest.svg?style=for-the-badge)](https://docs.rs/padded-number)

Used when "0" and "00" should be considered as distinct values. Encapsulated in
an efficient `PaddedNumber` type with, length bounds, ordering, and arithmetic
features included.

```rust
use padded_number::padded_number;

// macros creates a valid `PaddedNumber` at compile time
assert_eq!(padded_number!("001"), padded_number!("001"));
assert_ne!(padded_number!("0"), padded_number!("00"));
```

## Length bounds

```rust
use std::str::FromStr;
use padded_number::{PaddedNumber, bound_padded_number};

let from_macro = bound_padded_number!(2, 3, "123");
let from_str = PaddedNumber::<2, 3>::from_str("123").unwrap();
assert_eq!(from_macro, from_str);

// try_new is const fn compared to `FromStr`
assert!(PaddedNumber::<2, 3>::try_new("0").is_err());
assert!(PaddedNumber::<2, 3>::try_new("0000").is_err());
```

## Ordering

```rust
use padded_number::padded_number;

let a = padded_number!("0");
let b = padded_number!("00");
assert!(a < b);

let u = padded_number!("10");
let v = padded_number!("001");
assert!(u < v);
```

## Addition and subtraction with u64 as right-hand-side

Zeros being their own step is required to make padded number arithmetic consistent.

```rust
use padded_number::padded_number;

assert_eq!(
  padded_number!("9") + 1,
  padded_number!("00")
);

assert_eq!(
  padded_number!("000") - 1,
  padded_number!("99")
);
```

## Feature flags

All are disabled by default.

- `macros` - Enables the `padded_number!` and `bound_padded_number!` macros.
- `serde` - Enables serde support for `PaddedNumber`. Serialization is done to and from a plain string.
- `unstable-nightly` - Enables the `PaddedNumber::section` method which in turn
  relies on the unstable `generic_const_exprs` feature.