Merge pull request sekineh#34 from clint-white/rust-1.62.0

Synchronize with Rust 1.62.0

Author: sekineh

.github/workflows/rust.yml

@@ -16,14 +16,19 @@ jobs:
         - macos-latest
         rust:
         - stable
-        - 1.36.0 # MSRV (Rust 2018 and dev-dependency `serde_json`)
+        - 1.52.0  # MSRV
         cargo_args:
         - ""
         - --features serde
         include:
+          # Also test on nightly and Rust versions between MSRV and stable
+          # where there is conditional compilation
           - os: ubuntu-latest
             rust: nightly
             cargo_args: ""
+          - os: ubuntu-latest
+            rust: 1.56.0
+            cargo_args: ""
 
     runs-on: ${{ matrix.os }}
 

CHANGELOG.md

@@ -6,9 +6,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+* `#[must_use]` attribute to many methods, porting and extending several
+  rust-lang/rust PRs
+* Method `shrink_to()` for Rust 1.56.0 and greater, ported from rust-lang/rust
+* Implementation of `From<[T; N]>` for `BinaryHeap<T>` for Rust 1.56.0 or
+  greater, ported from rust-lang/rust#84111
+* Links to referenced items in the documenation
+* Example of a min-heap, ported from rust-lang/rust#60451
+* Documentation of time complexities of several methods, ported from
+  rust-lang/rust#60952
+
 ### Changed
 
-* Bump MSRV (minimum supported rust version) to rust 1.36.0.
+* Bump MSRV (minimum supported rust version) to rust 1.52.0.
+* Implement `From<BinaryHeap<T, C>>` for `Vec<T>` instead of `Into<Vec<T>>` for
+  `BinaryHeap<T, C>`
+* Port rust-lang/rust#77435 improvement to rebuild heuristic of
+  `BinaryHeap::append()`
+* Use italics with big-O notation in documentation, ported from
+  rust-lang/rust#71167
+* Relax trait bound `C: Compare<T>` on `BinaryHeap<T, C>` struct and certain
+  methods, in part ported from rust-lang/rust#58421
+* Synchronize internal implementation details with
+  `std::collections::BinaryHeap` in Rust 1.62.0
 
 ## [0.4.1] - 2021-01-06
 

Cargo.toml

@@ -10,6 +10,9 @@ keywords = ["binary", "heap", "priority", "queue"]
 categories = ["data-structures", "algorithms", ]
 edition = "2018"
 
+[build-dependencies]
+autocfg = "1"
+
 [dependencies]
 compare = "0.1.0"
 serde = { version = "1.0.116", optional = true, features = ["derive"] }

README.md

@@ -2,7 +2,8 @@
 
 ![Rust](https://github.com/sekineh/binary-heap-plus-rs/workflows/Rust/badge.svg)
 
-Enhancement over Rust's `std::collections::BinaryHeap`.
+Enhancement over Rust's
+[`std::collections::BinaryHeap`](https://doc.rust-lang.org/stable/std/collections/struct.BinaryHeap.html).
 
 It supports the following heaps and still maintains backward compatibility.
 - Max heap
@@ -19,14 +20,20 @@ Other notable added methods are:
 - `.into_iter_sorted()` which is less-surprising version of `.into_iter()`. The implementation is backported from `std`.
 - `.replace_cmp()` which replace the comparator of the existing heap.
 
-## MSRV (Minimum Supported Rust Version)
+## Compatibility and MSRV (Minimum Supported Rust Version)
 
-This crate requires Rust 1.36.0 or later.
+This crate is based on the standard library's implementation of
+[`BinaryHeap`](https://doc.rust-lang.org/stable/std/collections/struct.BinaryHeap.html)
+from Rust 1.62.0.
+
+This crate requires Rust 1.52.0 or later.  A few of its APIs are only available
+for more recent versions of Rust where they have been stabilized in the
+standard library; see the documentation for specifics.
 
 # Changes
 
-See CHANGELOG.md.
-https://github.com/sekineh/binary-heap-plus-rs/blob/master/CHANGELOG.md
+See
+[CHANGELOG.md](https://github.com/sekineh/binary-heap-plus-rs/blob/master/CHANGELOG.md).
 
 # Thanks
 

build.rs

@@ -0,0 +1,8 @@
+fn main() {
+    let ac = autocfg::new();
+
+    // Required for stabilization of `Vec::shrink_to()` and `IntoIterator` for arrays.
+    ac.emit_rustc_version(1, 56);
+
+    autocfg::rerun_path("build.rs");
+}