Merge branch 'develop' into develop

tony-iqlusion · web-flow · commit 78aa2f5475ff · 2020-01-30T15:40:20.000-08:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -8,6 +8,7 @@ members = [
     "stdtx",
     "subtle-encoding",
     "tai64",
+    "vint64",
     "zeroize",
     "zeroize_derive"
 ]
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# iqlusion crates <a href="https://www.iqlusion.io"><img src="https://storage.googleapis.com/iqlusion-production-web/img/logo/iqlusion-rings-sm.png" alt="iqlusion" width="24" height="24"></a> <a href="https://crates.io">📦</a>
+# iqlusion crates <a href="https://crates.io"><img src="https://storage.googleapis.com/iqlusion-production-web/github/companion-crate.png" alt="crate" width="24" height="24"></a> <a href="https://www.iqlusion.io"><img src="https://storage.googleapis.com/iqlusion-production-web/img/logo/iqlusion-rings-sm.png" alt="iqlusion" width="24" height="24"></a>
 
 [![Apache 2.0 Licensed][license-image]][license-link]
 ![MSRV][msrv-image]
@@ -45,6 +45,7 @@ This repository contains the following crates:
 | [stdtx]           | ![][stdtx-crate]           | Cosmos StdTx builder/signer/serializer        |
 | [subtle-encoding] | ![][subtle-encoding-crate] | Hex, Bech32, and Base64 in constant-time(ish) |
 | [tai64]           | ![][tai64-crate]           | TAI64(N) timestamp format                     |
+| [vint64]          | ![][vint64-crate]          | Simple and efficient 64-bit varint encoding   |
 | [zeroize]         | ![][zeroize-crate]         | Securely zero memory                          |
 
 ## License
@@ -97,5 +98,7 @@ without any additional terms or conditions.
 [subtle-encoding-crate]: https://img.shields.io/crates/v/subtle-encoding.svg
 [tai64]: https://github.com/iqlusioninc/crates/tree/develop/tai64
 [tai64-crate]: https://img.shields.io/crates/v/tai64.svg
+[vint64]: https://github.com/iqlusioninc/crates/tree/develop/vint64
+[vint64-crate]: https://img.shields.io/crates/v/vint64.svg
 [zeroize]: https://github.com/iqlusioninc/crates/tree/develop/zeroize
 [zeroize-crate]: https://img.shields.io/crates/v/zeroize.svg
diff --git a/anomaly/README.md b/anomaly/README.md
@@ -80,7 +80,7 @@ without any additional terms or conditions.
 [rustc-image]: https://img.shields.io/badge/rustc-1.36+-blue.svg
 [safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg
 [safety-link]: https://github.com/rust-secure-code/safety-dance/
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community
diff --git a/canonical-path/README.md b/canonical-path/README.md
@@ -55,7 +55,7 @@ without any additional terms or conditions.
 [license-image]: https://img.shields.io/badge/license-Apache2.0-blue.svg
 [license-link]: https://github.com/iqlusioninc/crates/blob/develop/LICENSE
 [rustc-image]: https://img.shields.io/badge/rustc-1.39+-blue.svg
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community
diff --git a/harp/README.md b/harp/README.md
@@ -57,7 +57,7 @@ without any additional terms or conditions.
 [rustc-image]: https://img.shields.io/badge/rustc-1.39+-blue.svg
 [safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg
 [safety-link]: https://github.com/rust-secure-code/safety-dance/
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community
diff --git a/hkd32/README.md b/hkd32/README.md
@@ -53,7 +53,7 @@ without any additional terms or conditions.
 [license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
 [license-link]: https://github.com/iqlusioninc/crates/blob/develop/LICENSE
 [rustc-image]: https://img.shields.io/badge/rustc-1.39+-blue.svg
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: hhttps://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community
diff --git a/secrecy/README.md b/secrecy/README.md
@@ -64,7 +64,7 @@ without any additional terms or conditions.
 [rustc-image]: https://img.shields.io/badge/rustc-1.39+-blue.svg
 [safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg
 [safety-link]: https://github.com/rust-secure-code/safety-dance/
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community
diff --git a/stdtx/README.md b/stdtx/README.md
@@ -31,7 +31,7 @@ uses the [StdTx] format without requiring upstream modifications.
 
 ## License
 
-Copyright © 2020 Tony Arcieri
+Copyright © 2020 iqlusion
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
diff --git a/subtle-encoding/README.md b/subtle-encoding/README.md
@@ -51,7 +51,7 @@ toplevel directory of this repository or [LICENSE-MIT] for details.
 [rustc-image]: https://img.shields.io/badge/rustc-1.39+-blue.svg
 [safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg
 [safety-link]: https://github.com/rust-secure-code/safety-dance/
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community
diff --git a/tai64/README.md b/tai64/README.md
@@ -55,7 +55,7 @@ without any additional terms or conditions.
 [rustc-image]: https://img.shields.io/badge/rustc-1.39+-blue.svg
 [safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg
 [safety-link]: https://github.com/rust-secure-code/safety-dance/
-[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg
+[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
 [build-link]: https://github.com/iqlusioninc/crates/actions
 [gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
 [gitter-link]: https://gitter.im/iqlusioninc/community
diff --git a/vint64/CHANGES.md b/vint64/CHANGES.md
@@ -0,0 +1,7 @@
+## 0.1.1 (2020-01-30)
+
+- Documentation fixups
+
+## 0.1.0 (2020-01-30)
+
+- Initial release
diff --git a/vint64/Cargo.toml b/vint64/Cargo.toml
@@ -0,0 +1,20 @@
+[package]
+name        = "vint64"
+description = "Simple and efficient variable-length integer encoding"
+version     = "0.1.1" # Also update html_root_url in lib.rs when bumping this
+authors     = ["Tony Arcieri <tony@iqlusion.io>"]
+license     = "Apache-2.0"
+edition     = "2018"
+homepage    = "https://github.com/iqlusioninc/crates/"
+repository  = "https://github.com/iqlusioninc/crates/tree/develop/vint64"
+readme      = "README.md"
+categories  = ["no-std", "parser-implementations"]
+keywords    = ["encoding", "integer", "leb128", "variable", "varint"]
+
+[dev-dependencies]
+criterion = "0.3"
+criterion-cycles-per-byte = "0.1"
+
+[[bench]]
+name = "vint64"
+harness = false
diff --git a/vint64/README.md b/vint64/README.md
@@ -0,0 +1,76 @@
+# vint64: simple and efficient variable-length integer encoding
+
+[![Crate][crate-image]][crate-link]
+[![Docs][docs-image]][docs-link]
+[![Apache 2.0 Licensed][license-image]][license-link]
+![MSRV][rustc-image]
+[![Safety Dance][safety-image]][safety-link]
+[![Build Status][build-image]][build-link]
+[![Gitter Chat][gitter-image]][gitter-link]
+
+`vint64` is an implementation of a variable-length encoding for 64-bit
+little endian integers which optimizes for simplicity and performance.
+
+[Documentation][docs-link]
+
+## About
+
+This crate implements a variable-length encoding for 64-bit little endian
+integers with a number of properties which make it superior in almost every
+way to other variable-length integer encodings like [LEB128], SQLite "Varuints",
+or CBOR:
+
+- Capable of expressing the full 64-bit integer range with a maximum of 9-bytes
+- Provides the most compact encoding possible for every value in range
+- No loops involved in decoding: just (unaligned) loads, masks, and shifts
+- No complex branch-heavy logic: decoding is CTZ + shifts and sanity checks
+- Total length of a `vint64` can be determined via the first byte alone
+
+Some precedent for this sort of encoding can be found in the
+[Extensible Binary Meta Language] (used by e.g. the [Matroska]
+media container format), however note that the specific type of "vint"
+used by that format still requires a loop to decode.
+
+## License
+
+Copyright © 2019-2020 iqlusion
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally
+submitted for inclusion in the work by you shall be dual licensed as above,
+without any additional terms or conditions.
+
+[//]: # (badges)
+
+[crate-image]: https://img.shields.io/crates/v/vint64.svg
+[crate-link]: https://crates.io/crates/vint64
+[docs-image]: https://docs.rs/vint64/badge.svg
+[docs-link]: https://docs.rs/vint64/
+[license-image]: https://img.shields.io/badge/license-Apache2.0-blue.svg
+[license-link]: https://github.com/iqlusioninc/crates/blob/develop/LICENSE
+[rustc-image]: https://img.shields.io/badge/rustc-1.39+-blue.svg
+[safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg
+[safety-link]: https://github.com/rust-secure-code/safety-dance/
+[build-image]: https://github.com/iqlusioninc/crates/workflows/Rust/badge.svg?branch=develop&event=push
+[build-link]: https://github.com/iqlusioninc/crates/actions
+[gitter-image]: https://badges.gitter.im/iqlusioninc/community.svg
+[gitter-link]: https://gitter.im/iqlusioninc/community
+
+[//]: # (general links)
+
+[LEB128]: https://cr.yp.to/libtai/vint.html
+[Extensible Binary Meta Language]: https://en.wikipedia.org/wiki/Extensible_Binary_Meta_Language
+[Matroska]: https://www.matroska.org/
diff --git a/vint64/benches/vint64.rs b/vint64/benches/vint64.rs
@@ -0,0 +1,58 @@
+//! vint64 benchmark (using criterion)
+
+use criterion::{criterion_group, criterion_main, Criterion};
+use criterion_cycles_per_byte::CyclesPerByte;
+
+const EXAMPLE_VALUES: [u64; 8] = [
+    0,
+    0x0f,
+    0x0f0f,
+    0x0f0f_f0f0,
+    0x0f0f_f0f0_0f0f,
+    0x0f0f_f0f0_0f0f_f0f0,
+    0xffff_ffff_0f0f_f0f0,
+    core::u64::MAX,
+];
+
+fn bench(c: &mut Criterion<CyclesPerByte>) {
+    let mut group = c.benchmark_group("vint64");
+
+    group.bench_function("encode", |b| {
+        let mut n = 0;
+        b.iter(|| {
+            vint64::encode(EXAMPLE_VALUES[n]);
+            n = (n + 1) & 0x07;
+        });
+    });
+
+    group.bench_function("decode", |b| {
+        let examples = [
+            vint64::encode(EXAMPLE_VALUES[0]),
+            vint64::encode(EXAMPLE_VALUES[1]),
+            vint64::encode(EXAMPLE_VALUES[2]),
+            vint64::encode(EXAMPLE_VALUES[3]),
+            vint64::encode(EXAMPLE_VALUES[4]),
+            vint64::encode(EXAMPLE_VALUES[5]),
+            vint64::encode(EXAMPLE_VALUES[6]),
+            vint64::encode(EXAMPLE_VALUES[7]),
+        ];
+
+        let mut n = 0;
+
+        b.iter(|| {
+            let mut slice = examples[n].as_ref();
+            vint64::decode(&mut slice).unwrap();
+            n = (n + 1) & 0x07;
+        });
+    });
+
+    group.finish();
+}
+
+criterion_group!(
+    name = benches;
+    config = Criterion::default().with_measurement(CyclesPerByte);
+    targets = bench
+);
+
+criterion_main!(benches);
diff --git a/vint64/src/lib.rs b/vint64/src/lib.rs
diff --git a/zeroize/README.md b/zeroize/README.md
diff --git a/zeroize_derive/README.md b/zeroize_derive/README.md

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ members = [`
`8`	`8`	`"stdtx",`
`9`	`9`	`"subtle-encoding",`
`10`	`10`	`"tai64",`
	`11`	`+ "vint64",`
`11`	`12`	`"zeroize",`
`12`	`13`	`"zeroize_derive"`
`13`	`14`	`]`