diff options
Diffstat (limited to 'vendor/nonempty/README.md')
| -rw-r--r-- | vendor/nonempty/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/vendor/nonempty/README.md b/vendor/nonempty/README.md new file mode 100644 index 00000000..0b18b605 --- /dev/null +++ b/vendor/nonempty/README.md @@ -0,0 +1,20 @@ +# Correct by Construction Non-Empty List + +This package exposes a type `NonEmpty<T>` with a data representation +that guarantees non-emptiness statically: + + struct NonEmpty<T>(T, Vec<T>) + +The library is meant to have an interface similar to `std::vec::Vec`: + + use nonempty::NonEmpty; + + let mut l = NonEmpty::new(42); + + assert_eq!(l.first(), &42); + + l.push(36); + l.push(58); + + let v: Vec<i32> = l.into(); + assert_eq!(v, vec![42, 36, 58]); |
