nonempty-containers 0.2.3

Fast, zero-cost conversion, and fully inter-operable nonempty container types.
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

# Non-Empty Containers

A simple set of non-empty alternatives to standard containers in Rust, including `NonEmptyVec`.

## Getting Started

Add this to your `Cargo.toml`:

```toml
# Cargo.toml

[dependencies]
nonempty-containers = "0.0.3"
```

The non-empty containers behave like their standard counterparts:

```rust
use nonempty_containers::NonEmptyVec;

let nev = NonEmptyVec::new(42, vec![1]);

nev.push(2);
nev.pop();
nev.pop();
assert_eq!(nev, NonEmptyVec::singleton(42));

// Errors!
nev.pop();
```

## Automatically Deriving `Arbitrary`

All non-empty containers can automatically derive `Arbitrary`, so long as the contained type 
also implements `Arbitrary`. This is useful for property-based testing, such as with `arbtest`.

```toml
# Cargo.toml

[dependencies]
nonempty-containers = { version = "0.0.2", features = ["arbitrary"] }
```

And then you can simply add `#[derive(Arbitrary)]` annotations to your types:

```rust
// pixels.rs

use arbitrary::Arbitrary;

#[derive(Arbitrary)]
pub struct Items(NonEmptyVec<u32>);
```