nz 0.1.1

Collection of 100% safe macros for creating numeric non-zero types more easily.
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

# nz (non-zero)


The `nz` crate provides a collection of user-friendly macros that simplify the creation
of new instances of non-zero numeric types found in the [`core::num`]. With these macros,
you can effortlessly generate instances using numeric literals, constant values and
constant expressions, all at compile time.

## Features


* No unsafe code
* No dependencies
* `no_std` compatible
* Supports all numeric non-zero types from the [`core::num`] module
* Compile time evaluation
* Zero detection at compile time

## `NonZero` macros


| Type | Macro |
|------|-------|
| [`NonZeroI8`](https://doc.rust-lang.org/stable/core/num/struct.NonZeroI8.html) | [`nz::i8!`](https://docs.rs/nz/%2A/nz/macro.i8.html) |
| [`NonZeroI16`](https://doc.rust-lang.org/stable/core/num/struct.NonZeroI16.html) | [`nz::i16!`](https://docs.rs/nz/%2A/nz/macro.i16.html) |
| [`NonZeroI32`](https://doc.rust-lang.org/stable/core/num/struct.NonZeroI32.html) | [`nz::i32!`](https://docs.rs/nz/%2A/nz/macro.i32.html) |
| [`NonZeroI64`](https://doc.rust-lang.org/stable/core/num/struct.NonZeroI64.html) | [`nz::i64!`](https://docs.rs/nz/%2A/nz/macro.i64.html) |
| [`NonZeroI128`](https://doc.rust-lang.org/stable/core/num/struct.NonZeroI128.html) | [`nz::i128!`](https://docs.rs/nz/%2A/nz/macro.i128.html) |
| [`NonZeroIsize`](https://doc.rust-lang.org/stable/core/num/struct.NonZeroIsize.html) | [`nz::isize!`](https://docs.rs/nz/%2A/nz/macro.isize.html) |
| [`NonZeroU8`](https://doc.rust-lang.org/stable/core/num/struct.NonZeroU8.html) | [`nz::u8!`](https://docs.rs/nz/%2A/nz/macro.u8.html) |
| [`NonZeroU16`](https://doc.rust-lang.org/stable/core/num/struct.NonZeroU16.html) | [`nz::u16!`](https://docs.rs/nz/%2A/nz/macro.u16.html) |
| [`NonZeroU32`](https://doc.rust-lang.org/stable/core/num/struct.NonZeroU32.html) | [`nz::u32!`](https://docs.rs/nz/%2A/nz/macro.u32.html) |
| [`NonZeroU64`](https://doc.rust-lang.org/stable/core/num/struct.NonZeroU64.html) | [`nz::u64!`](https://docs.rs/nz/%2A/nz/macro.u64.html) |
| [`NonZeroU128`](https://doc.rust-lang.org/stable/core/num/struct.NonZeroU128.html) | [`nz::u128!`](https://docs.rs/nz/%2A/nz/macro.u128.html) |
| [`NonZeroUsize`](https://doc.rust-lang.org/stable/core/num/struct.NonZeroUsize.html) | [`nz::usize!`](https://docs.rs/nz/%2A/nz/macro.usize.html) |

## Basic usage


```rust
use core::num::NonZeroU8;

const NZ_U8_MIN: NonZeroU8 = nz::u8!(1); // with numeric literal
const NZ_U8_MAX: NonZeroU8 = nz::u8!(u8::MAX); // with constant value
let sum = nz::u8!(NZ_U8_MAX.get() & NZ_U8_MIN.get() + 7); // with constant expression
```

## Remarks


Non-zero macros cannot be used with constant function arguments as they
are not constant values.

### Example


```rust, compile_fail
use core::num::NonZeroU64;

const fn wrapping_add_nz(a: u64, b: NonZeroU64) -> NonZeroU64 {
    // `a` and `b` is not constant
    nz::u64!(a.wrapping_add(b.get())) // <- cause of the compile error
}
let nz = wrapping_add_nz(2, nz::u64!(1));
```