rust-bitcoin / rust-bitcoin / 12241911208

83%

push

github

Merge rust-bitcoin/rust-bitcoin#3682: Add API scripts and output files

<a class=hub.com/rust-bitcoin/rust-bitcoin/commit/7e0501c03cbc02ccd9292a709b51deb96c74901d">7e0501c03<a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/1512d6a43ebfbab030d207a08d2d415dae8390d5"> Add a script to query the API (Tobin C. Harding)
<a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/e126a243074ffbe628a9c8425694db5fe93efb8a">e126a2430</a><a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/1512d6a43ebfbab030d207a08d2d415dae8390d5"> Add API script (Tobin C. Harding)
</a><a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/219ecd54980f28d02953fd5158ec8c3d6a034dc1">219ecd549</a> Add api text files (Tobin C. Harding)

Pull request description:

  Last time we did this there was push back by Kixunil because he did not like updating the API files. This time we only add API files for those crates we are focused on stabalizing.

  As we try to do the checklists for making sure the crates conform to the Rust API guidelines one has to repeatedly audit the code. Being able to quickly get lists of things out of the code is super useful.

  And the after we release 1.0 these API text files become valuable for review.

  --

  Add a script to generate API files using `cargo check-api` for the crates that we are trying to stabalise.

  - hashes
  - io
  - primitives
  - units

  Add a script to query the API files. E.g., `contrib/api.sh units types`

  Current commands are

  `types`: Show all public structs and enums
  `types_no_err`: Show all public structs and enums excluding errors
  `traits`:  Show all public traits

ACKs for top commit:
  apoelstra:
    ACK 7e0501c03cbc02ccd9292a709b51deb96c74901d; successfully ran local tests; let's do it

Tree-SHA512: d9fcff3dd9e019802137c658b9396294b76

20180 of 24354 relevant lines covered (82.86%)

17821.79 hits per line