rust-bitcoin-unsafe-fast/api
merge-script 0ac5b43040
Merge rust-bitcoin/rust-bitcoin#3823: Improve Cursor ref API
ae129d84ac api: Run just check-api (Tobin C. Harding)
3f433f1cde Improve Cursor ref API (Tobin C. Harding)

Pull request description:

  Our `Cursor` is a replacement of sorts for the `std::io::Cursor`. Users of the `Cursor` are likely to expect the same API so to get a reference and/or mutable reference users will likely reach for `get_ref` and `get_mut`. We should provide these.

  Deprecate `inner` since it is the same as `get_ref` but less idiomatically named (should have been `as_inner`).

  Add `get_ref` and `get_mut` methods to the `Cursor` type.

ACKs for top commit:
  apoelstra:
    ACK ae129d84ace03fba57bb980cace5aa60ff6bc10e; successfully ran local tests

Tree-SHA512: 664d08cc977c9d6e3319767c49bbabc8f21d681d570f50c514797a7737469cf861af60158ccc1c71d28baed542dabbbca586968144d60691ee0183a549a7b765
2024-12-30 18:13:29 +00:00
..
hashes api: Run just check-api 2024-12-29 08:42:34 +11:00
io api: Run just check-api 2024-12-29 09:20:39 +11:00
primitives api: Run just check-api 2024-12-12 16:28:49 +11:00
units api: Run just check-api 2024-12-30 06:36:10 +11:00
README.md api: document the need of cargo nightly 2024-12-15 11:42:52 -03:00

README.md

API text files

Each file here lists the public API when built with some set of features enabled. To create these files run ../contrib/check-for-api-changes.sh:

Requires cargo-public-api, install with:

cargo +nightly install cargo-public-api --locked

ref: https://github.com/enselic/cargo-public-api