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:

# Cargo.toml

[dependencies]
nonempty-containers = "0.2.3"

The non-empty containers behave like their standard counterparts:

// main.rs

use nonempty_containers::nev;

fn main() {
    // Usage: nev![head; tail]
    let nev = nev!(42; vec![1]);

    // Usage: nev![singular]
    let nev = nev![42];

    // Usage: nev![a, b, c, ...]
    let nev = nev![42, 1];

    nev.push(2);
    nev.pop();
    nev.pop();
    assert_eq!(nev, nev![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.

# Cargo.toml

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

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

// pixels.rs

use arbitrary::Arbitrary;
use nonempty_containers::NEVec;

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