hybrid-array v0.1.0 (#764)

Author: tarcieri

Cargo.lock

@@ -4,3 +4,6 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.1.0 (2022-05-07)
+- Initial release

hybrid-array/CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "hybrid-array"
-version = "0.0.0" # Also update html_root_url in lib.rs when bumping this
+version = "0.1.0" # Also update html_root_url in lib.rs when bumping this
 description = """
 Hybrid typenum-based and const generic array types designed to provide the
 flexibility of typenum-based expressions while also allowing interoperability
@@ -9,8 +9,9 @@ and a transition path to const generics
 authors = ["RustCrypto Developers"]
 license = "MIT OR Apache-2.0"
 documentation = "https://docs.rs/hybrid-array"
-repository = "https://github.com/RustCrypto/utils"
-categories = ["no-std"]
+repository = "https://github.com/RustCrypto/utils/tree/master/hybrid-array"
+categories = ["no-std", "data-structures"]
+keywords = ["generic-array"]
 readme = "README.md"
 edition = "2021"
 rust-version = "1.56"

hybrid-array/Cargo.toml

@@ -2,17 +2,29 @@
 
 [![crate][crate-image]][crate-link]
 [![Docs][docs-image]][docs-link]
+[![Build Status][build-image]][build-link]
+[![Safety Dance][safety-image]][safety-link]
 ![Apache2/MIT licensed][license-image]
 ![Rust Version][rustc-image]
 [![Project Chat][chat-image]][chat-link]
-[![Build Status][build-image]][build-link]
 
 Hybrid array type combining const generics with the expressiveness of
 [`typenum`]-based constraints, providing an alternative to [`generic-array`]
 and a incremental transition path to const generics.
 
 [Documentation][docs-link]
 
+## About
+
+This crate uses `typenum` to enable the following features which aren't yet
+possible with the stable implementation of const generics:
+
+- [#60551: Associated constants in traits can not be used in const generics][rust-issue-60551]
+- [#76560: Complex generic constants: `feature(generic_const_exprs)`][rust-issue-76560]
+
+Internally the crate is built on const generics and provides traits which make
+it possible to convert between const generic types and `typenum` types.
+
 ## License
 
 Licensed under either of:
@@ -30,18 +42,24 @@ dual licensed as above, without any additional terms or conditions.
 
 [//]: # (badges)
 
-[crate-image]: https://img.shields.io/crates/v/hybrid-array.svg
+[crate-image]: https://buildstats.info/crate/hybrid-array
 [crate-link]: https://crates.io/crates/hybrid-array
 [docs-image]: https://docs.rs/hybrid-array/badge.svg
 [docs-link]: https://docs.rs/hybrid-array/
+[build-image]: https://github.com/RustCrypto/utils/workflows/hybrid-array/badge.svg?branch=master&event=push
+[build-link]: https://github.com/RustCrypto/utils/actions/workflows/hybrid-array.yml
+[safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg
+[safety-link]: https://github.com/rust-secure-code/safety-dance/
 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
 [rustc-image]: https://img.shields.io/badge/rustc-1.56+-blue.svg
 [chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
 [chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260052-utils
-[build-image]: https://github.com/RustCrypto/utils/workflows/hybrid-array/badge.svg?branch=master&event=push
-[build-link]: https://github.com/RustCrypto/utils/actions/workflows/hybrid-array.yml
 
-[//]: # (general links)
+[//]: # (links)
 
 [RustCrypto]: https://github.com/rustcrypto
 [RustCrypto/utils#378]: https://github.com/RustCrypto/utils/issues/378
+[`typenum`]: https://github.com/paholg/typenum
+[`generic-array`]: https://github.com/fizyk20/generic-array
+[rust-issue-60551]: https://github.com/rust-lang/rust/issues/60551
+[rust-issue-76560]: https://github.com/rust-lang/rust/issues/76560

hybrid-array/README.md

@@ -3,11 +3,26 @@
 #![doc = include_str!("../README.md")]
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/RustCrypto/meta/master/logo.svg",
-    html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/meta/master/logo.svg",
-    html_root_url = "https://docs.rs/hybrid-array/0.0.0"
+    html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/meta/master/logo.svg"
+)]
+#![forbid(unsafe_code)]
+#![warn(
+    clippy::cast_lossless,
+    clippy::cast_possible_truncation,
+    clippy::cast_possible_wrap,
+    clippy::cast_precision_loss,
+    clippy::cast_sign_loss,
+    clippy::checked_conversions,
+    clippy::implicit_saturating_sub,
+    clippy::integer_arithmetic,
+    clippy::panic,
+    clippy::panic_in_result_fn,
+    clippy::unwrap_used,
+    missing_docs,
+    rust_2018_idioms,
+    unused_lifetimes,
+    unused_qualifications
 )]
-#![forbid(unsafe_code, clippy::unwrap_used)]
-#![warn(missing_docs, rust_2018_idioms)]
 
 pub use typenum;
 
@@ -60,7 +75,7 @@ pub trait ArrayOps<T, const N: usize>:
         let mut idx = 0;
         Self::from_core_array([(); N].map(|_| {
             let res = cb(idx);
-            idx += 1;
+            idx = idx.saturating_add(1); // TODO(tarcieri): better overflow handling?
             res
         }))
     }