#nonempty #nonzero #no-std #slice #vector

no-std not_empty

Slices and vectors that are statically guaranteed to be not empty

4 releases

Uses new Rust 2021

0.1.3 Sep 22, 2022
0.1.2 Sep 22, 2022
0.1.1 Sep 22, 2022
0.1.0 Sep 22, 2022

#486 in Data structures

Download history 74/week @ 2022-09-21

74 downloads per month

MIT/Apache

105KB
1.5K SLoC

not_empty

Slices and vectors that are statically guaranteed to be not empty.

Build Status Latest Version

This crate is particularly useful for various operations on slices or vectors that would otherwise return an option now return the value with no performance penalty.

Usage

This crate is on crates.io and can be used by adding not_empty to your dependencies in your project's Cargo.toml:

[dependencies]
not_empty = "0.1"

Documentation

View the full reference on docs.rs here.

Features

  • alloc enables the use of allocated types through the alloc crate.
  • serde enables the use of the serde crate to serialize and deserialize any not_empty types.
  • std enables the use of the standard library.

Note: A compiler error is thrown if both alloc and std features are enabled. Only choose up to one.

Only the std feature is enabled by default.

Motivation

There are other packages that solve this solution. When searching for my own, I primarily came across two other packages:

  • nonempty which only supported vectors and didn't have a solution to working elegantly with iterators. Also, interoperability between its exported NonEmpty type and other slices or vectors left much to be desired from an architectural support. To be pedantic, I was jaded that the NonEmpty type was larger than a standard vector for non-zero sized types.
  • non-empty-vec did not enlarge the type, which was good, but it did not meet my needs for interoperability as well.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies