reliq 0.2.1

A portable library of primitive-like constructs.
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

### !!! This crate is not stable yet. !!!

# Reliq
## A Numeric & Data Structure Toolkit designed for Portability.
A lightweight, `no_std` compatible library providing fixed-capacity arrays, UTF-8 strings, fixed-precision numeric types, and a generic numeric trait hierarchy. It is designed for portability where heap allocation may be undesirable, and predictablee arithmetic behaviour is required.



#### Fixed-Capacity Arrays
* `Array<const A: usize, B> -- stack-allocated, compile-time sized array.
* Supports:
    * `push`, `pop`, `insert`, `remove`.
    * `swap_insert` / `swap_remove` for unordered collections.
    * Conversion to slices `as_slice`, `as_mut_slice`, and iteration.
```rust
let mut arr: Array<4, u8> = Array::default();
arr.push(1).unwrap();
arr.push(2).unwrap();
arr.swap_insert(0, 5).unwrap();
assert_eq!(arr.len(), 3);
```


#### UTF-8
* `Utf8<const A: usize>` -- fixed-capacity Utf8 string.
* Supports safe `push`/`pop` of `char`, casting between capacities, and encoding/decoding from byte slices.
* Implements `Display`, `Debug`, `PartialEq`, `Eq`, `Ord`, and `PartialOrd`.
```rust
let mut s: Utf8<16> = Utf8::default();
s.push('H').unwrap();
s.push('i').unwrap();
assert_eq!(s.as_str(), "Hi");
```

#### Example

```rust
let mut value = 0;
let result = require(&mut value, |v| {
    *v += 1;
    Err("rollback")
});
assert_eq!(value, 0);
```



#### License
Apache-2.0